From 047a56d50c76666b6fe88fcc3a43cc2327e7ae3c Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 8 Feb 2023 10:52:15 +0000 Subject: [PATCH 01/82] Transform error messages --- lib/factory.js | 6 +++--- lib/validate.js | 6 +++--- package.json | 2 +- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/lib/factory.js b/lib/factory.js index 22ec236..9f232af 100644 --- a/lib/factory.js +++ b/lib/factory.js @@ -31,7 +31,7 @@ var ctors = require( '@stdlib/array-typed-real-float-ctors' ); var filledBy = require( '@stdlib/array-base-filled-by' ); var nullary = require( '@stdlib/strided-base-nullary' ); var binary = require( '@stdlib/strided-base-binary' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -144,7 +144,7 @@ function factory() { var dt; var o; if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) ); + throw new TypeError( format( 'null2p', len ) ); } o = {}; if ( arguments.length > 1 ) { @@ -184,7 +184,7 @@ function factory() { var dt; var o; if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) ); + throw new TypeError( format( 'null2p', len ) ); } o = {}; if ( arguments.length > 3 ) { diff --git a/lib/validate.js b/lib/validate.js index 40b9723..3629aaf 100644 --- a/lib/validate.js +++ b/lib/validate.js @@ -23,7 +23,7 @@ var dtypes = require( '@stdlib/array-typed-real-float-dtypes' ); var isObject = require( '@stdlib/assert-is-plain-object' ); var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // VARIABLES // @@ -55,12 +55,12 @@ DTYPES.push( 'generic' ); */ function validate( opts, options ) { if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); + return new TypeError( format( 'null2h', options ) ); } if ( hasOwnProp( options, 'dtype' ) ) { opts.dtype = options.dtype; if ( DTYPES.indexOf( opts.dtype ) < 0 ) { - return new TypeError( format( 'invalid option. `%s` option must be one of the following: "%s". Option: `%s`.', 'dtype', DTYPES.join( '", "' ), opts.dtype ) ); + return new TypeError( format( 'null3t', 'dtype', DTYPES.join( '", "' ), opts.dtype ) ); } } return null; diff --git a/package.json b/package.json index 486f4d2..8b6d28d 100644 --- a/package.json +++ b/package.json @@ -46,7 +46,7 @@ "@stdlib/random-base-uniform": "^0.0.6", "@stdlib/strided-base-binary": "^0.0.8", "@stdlib/strided-base-nullary": "^0.0.7", - "@stdlib/string-format": "^0.0.3", + "@stdlib/error-tools-fmtprodmsg": "^0.0.2", "@stdlib/types": "^0.0.14", "@stdlib/utils-constant-function": "^0.0.8", "@stdlib/utils-define-nonenumerable-read-only-accessor": "^0.0.7", From b43a54ef751eb9f74839ee20463d1847c1633b56 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 8 Feb 2023 11:01:46 +0000 Subject: [PATCH 02/82] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 62 - .github/workflows/cancel.yml | 56 - .github/workflows/close_pull_requests.yml | 44 - .github/workflows/examples.yml | 62 - .github/workflows/npm_downloads.yml | 108 - .github/workflows/productionize.yml | 798 --- .github/workflows/publish.yml | 236 - .github/workflows/test.yml | 97 - .github/workflows/test_bundles.yml | 180 - .github/workflows/test_coverage.yml | 123 - .github/workflows/test_install.yml | 83 - .gitignore | 184 - .npmignore | 227 - .npmrc | 28 - CHANGELOG.md | 5 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 59 +- benchmark/benchmark.float32.factory.js | 96 - benchmark/benchmark.float32.js | 98 - benchmark/benchmark.float64.factory.js | 96 - benchmark/benchmark.float64.js | 98 - benchmark/benchmark.generic.factory.js | 96 - benchmark/benchmark.generic.js | 98 - branches.md | 53 - docs/repl.txt | 192 - docs/types/test.ts | 355 -- examples/index.js | 48 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/defaults.json | 3 - lib/factory.js | 282 - lib/index.js | 77 - lib/main.js | 58 - lib/validate.js | 72 - package.json | 76 +- stats.html | 6177 +++++++++++++++++++++ test/test.factory.js | 1328 ----- test/test.js | 69 - test/test.main.js | 244 - test/test.validate.js | 118 - 47 files changed, 6214 insertions(+), 6657 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 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 benchmark/benchmark.float32.factory.js delete mode 100644 benchmark/benchmark.float32.js delete mode 100644 benchmark/benchmark.float64.factory.js delete mode 100644 benchmark/benchmark.float64.js delete mode 100644 benchmark/benchmark.generic.factory.js delete mode 100644 benchmark/benchmark.generic.js delete mode 100644 branches.md 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/defaults.json delete mode 100644 lib/factory.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/test.factory.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js delete mode 100644 test/test.validate.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 0fd4d6c..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 `tslint.json` files: -[tslint.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 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 c4ab52b..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/uniform) 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 06a9a75..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,62 +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' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 a00dbe5..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,56 +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' - uses: styfle/cancel-workflow-action@0.11.0 - 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 7eca213..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,44 +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: - run: - runs-on: ubuntu-latest - steps: - - uses: superbrothers/close-pull-request@v3 - 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/uniform) 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 7902a7d..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,62 +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 the repository: - - name: 'Checkout the repository' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 818b9df..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,108 +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: '33 9 * * 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' - uses: actions/checkout@v3 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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' - uses: actions/upload-artifact@v3 - 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' - uses: distributhor/workflow-webhook@v3 - 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 3e8e2db..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,798 +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' - uses: actions/checkout@v3 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 - - # Format error messages: - - name: 'Replace double quotes with single quotes in rewritten format string error messages' - run: | - find . -name "*.js" -exec sed -E -i "s/Error\( format\( \"([a-zA-Z0-9]+)\"/Error\( format\( '\1'/g" {} \; - - # Format string literal error messages: - - name: 'Replace double quotes with single quotes in rewritten string literal error messages' - run: | - find . -name "*.js" -exec sed -E -i "s/Error\( format\(\"([a-zA-Z0-9]+)\"\)/Error\( format\( '\1' \)/g" {} \; - - # Format code: - - name: 'Replace double quotes with single quotes in inserted `require` calls' - run: | - find . -name "*.js" -exec sed -E -i "s/require\( ?\"@stdlib\/error-tools-fmtprodmsg\" ?\);/require\( '@stdlib\/error-tools-fmtprodmsg' \);/g" {} \; - - # 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' }} - uses: actions/checkout@v3 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - uses: actions/setup-node@v3 - with: - node-version: 16 - 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' - uses: actions/checkout@v3 - - # 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' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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' - uses: act10ns/slack@v1 - 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' - uses: actions/checkout@v3 - - # 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' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 + + ```
@@ -364,7 +363,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]. @@ -424,11 +423,11 @@ Copyright © 2016-2023. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/random-array-uniform/main/LICENSE -[@stdlib/random/base/uniform]: https://github.com/stdlib-js/random-base-uniform +[@stdlib/random/base/uniform]: https://github.com/stdlib-js/random-base-uniform/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/benchmark/benchmark.float32.factory.js b/benchmark/benchmark.float32.factory.js deleted file mode 100644 index 67e61f4..0000000 --- a/benchmark/benchmark.float32.factory.js +++ /dev/null @@ -1,96 +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 bench = require( '@stdlib/bench' ); -var isnanf = require( '@stdlib/math-base-assert-is-nanf' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var fcn = uniform.factory( 2.0, 5.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 4642816..0000000 --- a/benchmark/benchmark.float32.js +++ /dev/null @@ -1,98 +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 bench = require( '@stdlib/bench' ); -var isnanf = require( '@stdlib/math-base-assert-is-nanf' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = 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 = uniform( len, 2.0, 5.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.factory.js b/benchmark/benchmark.float64.factory.js deleted file mode 100644 index 8646a54..0000000 --- a/benchmark/benchmark.float64.factory.js +++ /dev/null @@ -1,96 +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 bench = require( '@stdlib/bench' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var fcn = uniform.factory( 2.0, 5.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 5ee0d97..0000000 --- a/benchmark/benchmark.float64.js +++ /dev/null @@ -1,98 +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 bench = require( '@stdlib/bench' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = 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 = uniform( len, 2.0, 5.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.factory.js b/benchmark/benchmark.generic.factory.js deleted file mode 100644 index 7020d62..0000000 --- a/benchmark/benchmark.generic.factory.js +++ /dev/null @@ -1,96 +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 bench = require( '@stdlib/bench' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var fcn = uniform.factory( 2.0, 5.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 06a2a83..0000000 --- a/benchmark/benchmark.generic.js +++ /dev/null @@ -1,98 +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 bench = require( '@stdlib/bench' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = 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 = uniform( len, 2.0, 5.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 30542fb..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/uniform" -%% click B href "https://github.com/stdlib-js/random-array-uniform/tree/main" -%% click C href "https://github.com/stdlib-js/random-array-uniform/tree/production" -%% click D href "https://github.com/stdlib-js/random-array-uniform/tree/esm" -%% click E href "https://github.com/stdlib-js/random-array-uniform/tree/deno" -%% click F href "https://github.com/stdlib-js/random-array-uniform/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/uniform -[production-url]: https://github.com/stdlib-js/random-array-uniform/tree/production -[deno-url]: https://github.com/stdlib-js/random-array-uniform/tree/deno -[umd-url]: https://github.com/stdlib-js/random-array-uniform/tree/umd -[esm-url]: https://github.com/stdlib-js/random-array-uniform/tree/esm \ No newline at end of file diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 6ecb862..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,192 +0,0 @@ - -{{alias}}( len, a, b[, options] ) - Returns an array containing pseudorandom numbers drawn from a continuous - uniform distribution. - - Parameters - ---------- - len: integer - Output array length. - - a: number - Minimum support. - - b: number - Maximum support. - - 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) - Output array data type. Default: 'float64'. - - Returns - ------- - out: Array|Float64Array|Float32Array - Output array. - - Examples - -------- - > var out = {{alias}}( 3, 2.0, 5.0 ) - - - -{{alias}}.factory( [a, b, ][options] ) - Returns a function for creating arrays containing pseudorandom numbers drawn - from a continuous uniform distribution. - - If provided `a` and `b`, the returned function returns random variates drawn - from the specified distribution. - - If not provided `a` and `b`, the returned function requires that both `a` - and `b` 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. - - 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 ) - - - // Provide `a` and `b`: - > fcn = {{alias}}.factory( 2.0, 5.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 ) - - - // Get a copy of the current state: - > var state = {{alias}}.state - - - > out = {{alias}}( 3, 2.0, 5.0 ) - - > out = {{alias}}( 3, 2.0, 5.0 ) - - - // Set the state: - > {{alias}}.state = state; - - // Regenerate a previous array: - > out = {{alias}}( 3, 2.0, 5.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 09805a0..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,355 +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. -*/ - -import uniform = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - uniform( 10, 2, 3 ); // $ExpectType RandomArray - uniform( 10, 1, 2 ); // $ExpectType RandomArray - uniform( 10, 1, 2, {} ); // $ExpectType RandomArray -} - -// The compiler throws an error if the function is provided a first argument which is not a number... -{ - uniform( '5', 2.0, 5.0 ); // $ExpectError - uniform( true, 2.0, 5.0 ); // $ExpectError - uniform( false, 2.0, 5.0 ); // $ExpectError - uniform( null, 2.0, 5.0 ); // $ExpectError - uniform( [], 2.0, 5.0 ); // $ExpectError - uniform( {}, 2.0, 5.0 ); // $ExpectError - uniform( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - uniform( '5', 2.0, 5.0, {} ); // $ExpectError - uniform( true, 2.0, 5.0, {} ); // $ExpectError - uniform( false, 2.0, 5.0, {} ); // $ExpectError - uniform( null, 2.0, 5.0, {} ); // $ExpectError - uniform( [], 2.0, 5.0, {} ); // $ExpectError - uniform( {}, 2.0, 5.0, {} ); // $ExpectError - uniform( ( x: number ): number => x, 2.0, 5.0, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a number... -{ - uniform( 10, '5', 5.0 ); // $ExpectError - uniform( 10, true, 5.0 ); // $ExpectError - uniform( 10, false, 5.0 ); // $ExpectError - uniform( 10, null, 5.0 ); // $ExpectError - uniform( 10, [], 5.0 ); // $ExpectError - uniform( 10, {}, 5.0 ); // $ExpectError - uniform( 10, ( x: number ): number => x, 5.0 ); // $ExpectError - - uniform( 10, '5', 5.0, {} ); // $ExpectError - uniform( 10, true, 5.0, {} ); // $ExpectError - uniform( 10, false, 5.0, {} ); // $ExpectError - uniform( 10, null, 5.0, {} ); // $ExpectError - uniform( 10, [], 5.0, {} ); // $ExpectError - uniform( 10, {}, 5.0, {} ); // $ExpectError - uniform( 10, ( x: number ): number => x, 5.0, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a number... -{ - uniform( 10, 2.0, '5' ); // $ExpectError - uniform( 10, 2.0, true ); // $ExpectError - uniform( 10, 2.0, false ); // $ExpectError - uniform( 10, 2.0, null ); // $ExpectError - uniform( 10, 2.0, [] ); // $ExpectError - uniform( 10, 2.0, {} ); // $ExpectError - uniform( 10, 2.0, ( x: number ): number => x ); // $ExpectError - - uniform( 10, 2.0, '5', {} ); // $ExpectError - uniform( 10, 2.0, true, {} ); // $ExpectError - uniform( 10, 2.0, false, {} ); // $ExpectError - uniform( 10, 2.0, null, {} ); // $ExpectError - uniform( 10, 2.0, [], {} ); // $ExpectError - uniform( 10, 2.0, {}, {} ); // $ExpectError - uniform( 10, 2.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... -{ - uniform( 10, 2.0, 5.0, '5' ); // $ExpectError - uniform( 10, 2.0, 5.0, 5 ); // $ExpectError - uniform( 10, 2.0, 5.0, true ); // $ExpectError - uniform( 10, 2.0, 5.0, false ); // $ExpectError - uniform( 10, 2.0, 5.0, [] ); // $ExpectError - uniform( 10, 2.0, 5.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... -{ - uniform( 10, 2.0, 5.0, { 'dtype': 123 } ); // $ExpectError - uniform( 10, 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - uniform( 10, 2.0, 5.0, { 'dtype': null } ); // $ExpectError - uniform( 10, 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - uniform( 10, 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - uniform( 10, 2.0, 5.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - uniform(); // $ExpectError - uniform( 10 ); // $ExpectError - uniform( 10, 2.0 ); // $ExpectError - uniform( 10, 2.0, 5.0, {}, {} ); // $ExpectError -} - -// Attached to main export is a `factory` method which returns a function... -{ - uniform.factory( 2.0, 5.0 ); // $ExpectType UnaryFunction - uniform.factory( 2.0, 5.0, { 'copy': false } ); // $ExpectType UnaryFunction - - uniform.factory(); // $ExpectType TernaryFunction - uniform.factory( { 'copy': false } ); // $ExpectType TernaryFunction -} - -// The `factory` method returns a function which returns an array... -{ - const fcn1 = uniform.factory( 2.0, 5.0 ); - fcn1( 10, ); // $ExpectType RandomArray - - const fcn2 = uniform.factory(); - fcn2( 10, 2.0, 5.0 ); // $ExpectType RandomArray -} - -// The compiler throws an error if the `factory` method is provided invalid arguments... -{ - uniform.factory( '5', 5.0 ); // $ExpectError - uniform.factory( true, 5.0 ); // $ExpectError - uniform.factory( false, 5.0 ); // $ExpectError - uniform.factory( [], 5.0 ); // $ExpectError - uniform.factory( {}, 5.0 ); // $ExpectError - uniform.factory( ( x: number ): number => x, 5.0 ); // $ExpectError - - uniform.factory( '5', 5.0, {} ); // $ExpectError - uniform.factory( true, 5.0, {} ); // $ExpectError - uniform.factory( false, 5.0, {} ); // $ExpectError - uniform.factory( [], 5.0, {} ); // $ExpectError - uniform.factory( {}, 5.0, {} ); // $ExpectError - uniform.factory( ( x: number ): number => x, 5.0, {} ); // $ExpectError - - uniform.factory( 2.0, '5' ); // $ExpectError - uniform.factory( 2.0, true ); // $ExpectError - uniform.factory( 2.0, false ); // $ExpectError - uniform.factory( 2.0, [] ); // $ExpectError - uniform.factory( 2.0, {} ); // $ExpectError - uniform.factory( 2.0, ( x: number ): number => x ); // $ExpectError - - uniform.factory( 2.0, '5', {} ); // $ExpectError - uniform.factory( 2.0, true, {} ); // $ExpectError - uniform.factory( 2.0, false, {} ); // $ExpectError - uniform.factory( 2.0, [], {} ); // $ExpectError - uniform.factory( 2.0, {}, {} ); // $ExpectError - uniform.factory( 2.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... -{ - uniform.factory( null ); // $ExpectError - uniform.factory( 2.0, 5.0, null ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided a `prng` option which is not a pseudorandom number generator... -{ - uniform.factory( 2.0, 5.0, { 'prng': 123 } ); // $ExpectError - uniform.factory( 2.0, 5.0, { 'prng': 'abc' } ); // $ExpectError - uniform.factory( 2.0, 5.0, { 'prng': null } ); // $ExpectError - uniform.factory( 2.0, 5.0, { 'prng': [] } ); // $ExpectError - uniform.factory( 2.0, 5.0, { 'prng': {} } ); // $ExpectError - uniform.factory( 2.0, 5.0, { 'prng': true ); // $ExpectError - - uniform.factory( { 'prng': 123 } ); // $ExpectError - uniform.factory( { 'prng': 'abc' } ); // $ExpectError - uniform.factory( { 'prng': null } ); // $ExpectError - uniform.factory( { 'prng': [] } ); // $ExpectError - uniform.factory( { 'prng': {} } ); // $ExpectError - uniform.factory( { 'prng': true ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided a `seed` option which is not a valid seed... -{ - uniform.factory( 2.0, 5.0, { 'seed': true } ); // $ExpectError - uniform.factory( 2.0, 5.0, { 'seed': 'abc' } ); // $ExpectError - uniform.factory( 2.0, 5.0, { 'seed': null } ); // $ExpectError - uniform.factory( 2.0, 5.0, { 'seed': [ 'a' ] } ); // $ExpectError - uniform.factory( 2.0, 5.0, { 'seed': {} } ); // $ExpectError - uniform.factory( 2.0, 5.0, { 'seed': ( x: number ): number => x } ); // $ExpectError - - uniform.factory( { 'seed': true } ); // $ExpectError - uniform.factory( { 'seed': 'abc' } ); // $ExpectError - uniform.factory( { 'seed': null } ); // $ExpectError - uniform.factory( { 'seed': [ 'a' ] } ); // $ExpectError - uniform.factory( { 'seed': {} } ); // $ExpectError - uniform.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... -{ - uniform.factory( 2.0, 5.0, { 'state': 123 } ); // $ExpectError - uniform.factory( 2.0, 5.0, { 'state': 'abc' } ); // $ExpectError - uniform.factory( 2.0, 5.0, { 'state': null } ); // $ExpectError - uniform.factory( 2.0, 5.0, { 'state': [] } ); // $ExpectError - uniform.factory( 2.0, 5.0, { 'state': {} } ); // $ExpectError - uniform.factory( 2.0, 5.0, { 'state': true ); // $ExpectError - uniform.factory( 2.0, 5.0, { 'state': ( x: number ): number => x } ); // $ExpectError - - uniform.factory( { 'state': 123 } ); // $ExpectError - uniform.factory( { 'state': 'abc' } ); // $ExpectError - uniform.factory( { 'state': null } ); // $ExpectError - uniform.factory( { 'state': [] } ); // $ExpectError - uniform.factory( { 'state': {} } ); // $ExpectError - uniform.factory( { 'state': true ); // $ExpectError - uniform.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... -{ - uniform.factory( 2.0, 5.0, { 'copy': 123 } ); // $ExpectError - uniform.factory( 2.0, 5.0, { 'copy': 'abc' } ); // $ExpectError - uniform.factory( 2.0, 5.0, { 'copy': null } ); // $ExpectError - uniform.factory( 2.0, 5.0, { 'copy': [] } ); // $ExpectError - uniform.factory( 2.0, 5.0, { 'copy': {} } ); // $ExpectError - uniform.factory( 2.0, 5.0, { 'copy': ( x: number ): number => x } ); // $ExpectError - - uniform.factory( { 'copy': 123 } ); // $ExpectError - uniform.factory( { 'copy': 'abc' } ); // $ExpectError - uniform.factory( { 'copy': null } ); // $ExpectError - uniform.factory( { 'copy': [] } ); // $ExpectError - uniform.factory( { 'copy': {} } ); // $ExpectError - uniform.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... -{ - uniform.factory( 2.0, 5.0, { 'dtype': 123 } ); // $ExpectError - uniform.factory( 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - uniform.factory( 2.0, 5.0, { 'dtype': null } ); // $ExpectError - uniform.factory( 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - uniform.factory( 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - uniform.factory( 2.0, 5.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError - - uniform.factory( { 'dtype': 123 } ); // $ExpectError - uniform.factory( { 'dtype': 'abc' } ); // $ExpectError - uniform.factory( { 'dtype': null } ); // $ExpectError - uniform.factory( { 'dtype': [] } ); // $ExpectError - uniform.factory( { 'dtype': {} } ); // $ExpectError - uniform.factory( { 'dtype': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided more than three arguments... -{ - uniform.factory( 2.0, 5.0, {}, {} ); // $ExpectError -} - -// The compiler throws an error if the function returned by the `factory` method is provided invalid arguments... -{ - const fcn1 = uniform.factory( 2.0, 5.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 = uniform.factory(); - fcn2( true, 2.0, 5.0 ); // $ExpectError - fcn2( false, 2.0, 5.0 ); // $ExpectError - fcn2( '5', 2.0, 5.0 ); // $ExpectError - fcn2( [], 2.0, 5.0 ); // $ExpectError - fcn2( {}, 2.0, 5.0 ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - fcn2( true, 2.0, 5.0, {} ); // $ExpectError - fcn2( false, 2.0, 5.0, {} ); // $ExpectError - fcn2( '5', 2.0, 5.0, {} ); // $ExpectError - fcn2( [], 2.0, 5.0, {} ); // $ExpectError - fcn2( {}, 2.0, 5.0, {} ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0, {} ); // $ExpectError - - fcn2( 10, true, 5.0 ); // $ExpectError - fcn2( 10, false, 5.0 ); // $ExpectError - fcn2( 10, '5', 5.0 ); // $ExpectError - fcn2( 10, [], 5.0 ); // $ExpectError - fcn2( 10, {}, 5.0 ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0 ); // $ExpectError - - fcn2( 10, true, 5.0, {} ); // $ExpectError - fcn2( 10, false, 5.0, {} ); // $ExpectError - fcn2( 10, '5', 5.0, {} ); // $ExpectError - fcn2( 10, [], 5.0, {} ); // $ExpectError - fcn2( 10, {}, 5.0, {} ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0, {} ); // $ExpectError - - fcn2( 10, 2.0, true ); // $ExpectError - fcn2( 10, 2.0, false ); // $ExpectError - fcn2( 10, 2.0, '5' ); // $ExpectError - fcn2( 10, 2.0, [] ); // $ExpectError - fcn2( 10, 2.0, {} ); // $ExpectError - fcn2( 10, 2.0, ( x: number ): number => x ); // $ExpectError - - fcn2( 10, 2.0, true, {} ); // $ExpectError - fcn2( 10, 2.0, false, {} ); // $ExpectError - fcn2( 10, 2.0, '5', {} ); // $ExpectError - fcn2( 10, 2.0, [], {} ); // $ExpectError - fcn2( 10, 2.0, {}, {} ); // $ExpectError - fcn2( 10, 2.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 = uniform.factory(); - fcn1( 2.0, 5.0, { 'dtype': 123 } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': null } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError - - const fcn2 = uniform.factory( 2.0, 5.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 = uniform.factory( 2.0, 5.0 ); - fcn1(); // $ExpectError - fcn1( 1, 1, 1 ); // $ExpectError - - const fcn2 = uniform.factory(); - fcn2(); // $ExpectError - fcn2( 1 ); // $ExpectError - fcn2( 1, 1, 1, 1 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index c485546..0000000 --- a/examples/index.js +++ /dev/null @@ -1,48 +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'; - -var logEach = require( '@stdlib/console-log-each' ); -var uniform = require( './../lib' ); - -// Create a function for generating random arrays originating from the same state: -var random = uniform.factory( 2.0, 5.0, { - 'state': uniform.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 = uniform.factory( 2.0, 5.0, { - 'state': uniform.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 999d36d..cf23637 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 2.0 -/// +/// import { FloatDataType, 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..a4cb981 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-accessor@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-write-accessor@esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-constant-function@esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-noop@v0.0.14-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/random-base-uniform@esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-typed-real-float-ctors@esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-nullary@esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@esm/index.mjs";import f from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.0.2-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/array-typed-real-float-dtypes@esm/index.mjs";import h from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@esm/index.mjs";var u="float64",c=a();function y(e,t){return h(t)?j(t,"dtype")&&(e.dtype=t.dtype,c.indexOf(e.dtype)<0)?new TypeError(f("null3t","dtype",c.join('", "'),e.dtype)):null:new TypeError(f("null2h",t))}function g(){var a,h,j,c,g,b;if(j={dtype:u},0===(h=arguments.length))g=d,c=x;else if(1===h){if(a=arguments[0],g=d.factory(a),b=y(j,a))throw b;c=x}else if(2===h)g=d.factory(arguments[0],arguments[1]),c=v;else if(3===h){if(a=arguments[2],g=d.factory(arguments[0],arguments[1],a),b=y(j,a))throw b;c=v}return a&&a.prng?(e(c,"seed",null),e(c,"seedLength",null),s(c,"state",r(null),i),e(c,"stateLength",null),e(c,"byteLength",null)):(n(c,"seed",w),n(c,"seedLength",L),s(c,"state",P,R),n(c,"stateLength",G),n(c,"byteLength",N)),e(c,"PRNG",g.PRNG),c;function v(e,n){var s,r,i,d;if(!t(e))throw new TypeError(f("null2p",e));if(d={},arguments.length>1&&(r=y(d,n)))throw r;return"generic"===(i=d.dtype||j.dtype)?l(e,g):(s=new(o(i))(e),m([s],[e],[1],g),s)}function x(e,n,s,r){var i,d,m,a;if(!t(e))throw new TypeError(f("null2p",e));if(a={},arguments.length>3&&(d=y(a,r)))throw d;return"generic"===(m=a.dtype||j.dtype)?l(e,h):(i=new(o(m))(e),p([[n],[s],i],[e],[0,0,1],g),i);function h(){return g(n,s)}}function w(){return c.PRNG.seed}function L(){return c.PRNG.seedLength}function G(){return c.PRNG.stateLength}function N(){return c.PRNG.byteLength}function P(){return c.PRNG.state}function R(e){c.PRNG.state=e}}c.push("generic");var b=g();e(b,"factory",g);export{b as default,g as factory}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..4984bd1 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/factory.js","../lib/main.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 dtypes from '@stdlib/array-typed-real-float-dtypes';\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes();\nDTYPES.push( 'generic' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( 'null2h', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( DTYPES.indexOf( opts.dtype ) < 0 ) {\n\t\t\treturn new TypeError( format( 'null3t', 'dtype', DTYPES.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport setReadOnlyAccessor from '@stdlib/utils-define-nonenumerable-read-only-accessor';\nimport setReadWriteAccessor from '@stdlib/utils-define-nonenumerable-read-write-accessor';\nimport constantFunction from '@stdlib/utils-constant-function';\nimport noop from '@stdlib/utils-noop';\nimport base from '@stdlib/random-base-uniform';\nimport ctors from '@stdlib/array-typed-real-float-ctors';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport nullary from '@stdlib/strided-base-nullary';\nimport binary from '@stdlib/strided-base-binary';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution.\n*\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\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 {RangeError} `a` must be less than `b`\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 uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10 );\n* // returns \n*\n* @example\n* var uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nfunction factory() {\n\tvar options;\n\tvar nargs;\n\tvar opts;\n\tvar rand;\n\tvar prng;\n\tvar err;\n\n\topts = {\n\t\t'dtype': defaults.dtype\n\t};\n\n\tnargs = arguments.length;\n\tif ( nargs === 0 ) {\n\t\tprng = base;\n\t\trand = uniform2;\n\t} else if ( nargs === 1 ) {\n\t\toptions = arguments[ 0 ];\n\t\tprng = base.factory( options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform2;\n\t} else if ( nargs === 2 ) {\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ] );\n\t\trand = uniform1;\n\t} else if ( nargs === 3 ) {\n\t\toptions = arguments[ 2 ];\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ], options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform1;\n\t}\n\tif ( options && options.prng ) {\n\t\tsetReadOnly( rand, 'seed', null );\n\t\tsetReadOnly( rand, 'seedLength', null );\n\t\tsetReadWriteAccessor( rand, 'state', constantFunction( null ), noop );\n\t\tsetReadOnly( rand, 'stateLength', null );\n\t\tsetReadOnly( rand, 'byteLength', null );\n\t} else {\n\t\tsetReadOnlyAccessor( rand, 'seed', getSeed );\n\t\tsetReadOnlyAccessor( rand, 'seedLength', getSeedLength );\n\t\tsetReadWriteAccessor( rand, 'state', getState, setState );\n\t\tsetReadOnlyAccessor( rand, 'stateLength', getStateLength );\n\t\tsetReadOnlyAccessor( rand, 'byteLength', getStateSize );\n\t}\n\tsetReadOnly( rand, 'PRNG', prng.PRNG );\n\treturn rand;\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform1( len, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( 'null2p', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 1 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, prng );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tnullary( [ out ], [ len ], [ 1 ], prng );\n\t\treturn out;\n\t}\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {number} a - minimum support\n\t* @param {number} b - maximum support\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform2( len, a, b, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( 'null2p', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 3 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\t// NOTE: we could alternatively use the PRNG factory function to create a PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. Decision made here to avoid this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom number. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in a return value of `NaN`.\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, wrapper );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tbinary( [ [ a ], [ b ], out ], [ len ], [ 0, 0, 1 ], prng );\n\t\treturn out;\n\n\t\t/**\n\t\t* Applies parameters to a pseudorandom number generator function.\n\t\t*\n\t\t* @private\n\t\t* @returns {number} pseudorandom number\n\t\t*/\n\t\tfunction wrapper() {\n\t\t\treturn prng( a, b );\n\t\t}\n\t}\n\n\t/**\n\t* Returns the PRNG seed.\n\t*\n\t* @private\n\t* @returns {PRNGSeedMT19937} seed\n\t*/\n\tfunction getSeed() {\n\t\treturn rand.PRNG.seed;\n\t}\n\n\t/**\n\t* Returns the PRNG seed length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} seed length\n\t*/\n\tfunction getSeedLength() {\n\t\treturn rand.PRNG.seedLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state length\n\t*/\n\tfunction getStateLength() {\n\t\treturn rand.PRNG.stateLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state size (in bytes).\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state size (in bytes)\n\t*/\n\tfunction getStateSize() {\n\t\treturn rand.PRNG.byteLength;\n\t}\n\n\t/**\n\t* Returns the current pseudorandom number generator state.\n\t*\n\t* @private\n\t* @returns {PRNGStateMT19937} current state\n\t*/\n\tfunction getState() {\n\t\treturn rand.PRNG.state;\n\t}\n\n\t/**\n\t* Sets the pseudorandom number generator state.\n\t*\n\t* @private\n\t* @param {PRNGStateMT19937} s - generator state\n\t* @throws {Error} must provide a valid state\n\t*/\n\tfunction setState( s ) {\n\t\trand.PRNG.state = s;\n\t}\n}\n\n\n// EXPORTS //\n\nexport default factory;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @name uniform\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\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 = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar uniform = factory();\n\n\n// EXPORTS //\n\nexport default uniform;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @module @stdlib/random-array-uniform\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.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\" }\n"],"names":["DTYPES","dtypes","validate","opts","options","isObject","hasOwnProp","dtype","indexOf","TypeError","format","join","factory","nargs","rand","prng","err","defaults","arguments","length","base","uniform2","uniform1","setReadOnly","setReadWriteAccessor","constantFunction","noop","setReadOnlyAccessor","getSeed","getSeedLength","getState","setState","getStateLength","getStateSize","PRNG","len","out","dt","o","isNonNegativeInteger","filledBy","ctors","nullary","a","b","wrapper","binary","seed","seedLength","stateLength","byteLength","state","s","push","uniform","main"],"mappings":";;07CA8BIA,EAASC,IAyBb,SAASC,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,WACzBD,EAAKI,MAAQH,EAAQG,MAChBP,EAAOQ,QAASL,EAAKI,OAAU,GAC5B,IAAIE,UAAWC,EAAQ,SAAU,QAASV,EAAOW,KAAM,QAAUR,EAAKI,QAGxE,KARC,IAAIE,UAAWC,EAAQ,SAAUN,GAS1C,CCSA,SAASQ,IACR,IAAIR,EACAS,EACAV,EACAW,EACAC,EACAC,EAOJ,GALAb,EAAO,CACNI,MAASU,GAIK,KADfJ,EAAQK,UAAUC,QAEjBJ,EAAOK,EACPN,EAAOO,OACD,GAAe,IAAVR,EAAc,CAIzB,GAHAT,EAAUc,UAAW,GACrBH,EAAOK,EAAKR,QAASR,GACrBY,EAAMd,EAAUC,EAAMC,GAErB,MAAMY,EAEPF,EAAOO,CACT,MAAQ,GAAe,IAAVR,EACXE,EAAOK,EAAKR,QAASM,UAAW,GAAKA,UAAW,IAChDJ,EAAOQ,OACD,GAAe,IAAVT,EAAc,CAIzB,GAHAT,EAAUc,UAAW,GACrBH,EAAOK,EAAKR,QAASM,UAAW,GAAKA,UAAW,GAAKd,GACrDY,EAAMd,EAAUC,EAAMC,GAErB,MAAMY,EAEPF,EAAOQ,CACP,CAeD,OAdKlB,GAAWA,EAAQW,MACvBQ,EAAaT,EAAM,OAAQ,MAC3BS,EAAaT,EAAM,aAAc,MACjCU,EAAsBV,EAAM,QAASW,EAAkB,MAAQC,GAC/DH,EAAaT,EAAM,cAAe,MAClCS,EAAaT,EAAM,aAAc,QAEjCa,EAAqBb,EAAM,OAAQc,GACnCD,EAAqBb,EAAM,aAAce,GACzCL,EAAsBV,EAAM,QAASgB,EAAUC,GAC/CJ,EAAqBb,EAAM,cAAekB,GAC1CL,EAAqBb,EAAM,aAAcmB,IAE1CV,EAAaT,EAAM,OAAQC,EAAKmB,MACzBpB,EAcP,SAASQ,EAAUa,EAAK/B,GACvB,IACIgC,EACApB,EACAqB,EACAC,EACJ,IAAMC,EAAsBJ,GAC3B,MAAM,IAAI1B,UAAWC,EAAQ,SAAUyB,IAGxC,GADAG,EAAI,CAAA,EACCpB,UAAUC,OAAS,IACvBH,EAAMd,EAAUoC,EAAGlC,IAElB,MAAMY,EAIR,MAAY,aADZqB,EAAKC,EAAE/B,OAASJ,EAAKI,OAEbiC,EAAUL,EAAKpB,IAGvBqB,EAAM,IADCK,EAAOJ,GACR,CAAUF,GAChBO,EAAS,CAAEN,GAAO,CAAED,GAAO,CAAE,GAAKpB,GAC3BqB,EACP,CAgBD,SAASf,EAAUc,EAAKQ,EAAGC,EAAGxC,GAC7B,IACIgC,EACApB,EACAqB,EACAC,EACJ,IAAMC,EAAsBJ,GAC3B,MAAM,IAAI1B,UAAWC,EAAQ,SAAUyB,IAGxC,GADAG,EAAI,CAAA,EACCpB,UAAUC,OAAS,IACvBH,EAAMd,EAAUoC,EAAGlC,IAElB,MAAMY,EAKR,MAAY,aADZqB,EAAKC,EAAE/B,OAASJ,EAAKI,OAEbiC,EAAUL,EAAKU,IAGvBT,EAAM,IADCK,EAAOJ,GACR,CAAUF,GAChBW,EAAQ,CAAE,CAAEH,GAAK,CAAEC,GAAKR,GAAO,CAAED,GAAO,CAAE,EAAG,EAAG,GAAKpB,GAC9CqB,GAQP,SAASS,IACR,OAAO9B,EAAM4B,EAAGC,EAChB,CACD,CAQD,SAAShB,IACR,OAAOd,EAAKoB,KAAKa,IACjB,CAQD,SAASlB,IACR,OAAOf,EAAKoB,KAAKc,UACjB,CAQD,SAAShB,IACR,OAAOlB,EAAKoB,KAAKe,WACjB,CAQD,SAAShB,IACR,OAAOnB,EAAKoB,KAAKgB,UACjB,CAQD,SAASpB,IACR,OAAOhB,EAAKoB,KAAKiB,KACjB,CASD,SAASpB,EAAUqB,GAClBtC,EAAKoB,KAAKiB,MAAQC,CAClB,CACF,CDrPApD,EAAOqD,KAAM,WEqBV,IAACC,EAAU1C,ICiBdW,EAAAgC,EAAA,UAAA3C"} \ No newline at end of file diff --git a/lib/defaults.json b/lib/defaults.json deleted file mode 100644 index 83f4438..0000000 --- a/lib/defaults.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "dtype": "float64" -} diff --git a/lib/factory.js b/lib/factory.js deleted file mode 100644 index 9f232af..0000000 --- a/lib/factory.js +++ /dev/null @@ -1,282 +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 isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var setReadOnlyAccessor = require( '@stdlib/utils-define-nonenumerable-read-only-accessor' ); -var setReadWriteAccessor = require( '@stdlib/utils-define-nonenumerable-read-write-accessor' ); -var constantFunction = require( '@stdlib/utils-constant-function' ); -var noop = require( '@stdlib/utils-noop' ); -var base = require( '@stdlib/random-base-uniform' ); -var ctors = require( '@stdlib/array-typed-real-float-ctors' ); -var filledBy = require( '@stdlib/array-base-filled-by' ); -var nullary = require( '@stdlib/strided-base-nullary' ); -var binary = require( '@stdlib/strided-base-binary' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution. -* -* @param {number} [a] - minimum support -* @param {number} [b] - maximum support -* @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 {RangeError} `a` must be less than `b` -* @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 uniform = factory( 2.0, 5.0 ); -* // returns -* -* var arr = uniform( 10 ); -* // returns -* -* @example -* var uniform = factory( 2.0, 5.0 ); -* // returns -* -* var arr = uniform( 10, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -function factory() { - var options; - var nargs; - var opts; - var rand; - var prng; - var err; - - opts = { - 'dtype': defaults.dtype - }; - - nargs = arguments.length; - if ( nargs === 0 ) { - prng = base; - rand = uniform2; - } else if ( nargs === 1 ) { - options = arguments[ 0 ]; - prng = base.factory( options ); - err = validate( opts, options ); - if ( err ) { - throw err; - } - rand = uniform2; - } else if ( nargs === 2 ) { - prng = base.factory( arguments[ 0 ], arguments[ 1 ] ); - rand = uniform1; - } else if ( nargs === 3 ) { - options = arguments[ 2 ]; - prng = base.factory( arguments[ 0 ], arguments[ 1 ], options ); - err = validate( opts, options ); - if ( err ) { - throw err; - } - rand = uniform1; - } - if ( options && options.prng ) { - setReadOnly( rand, 'seed', null ); - setReadOnly( rand, 'seedLength', null ); - setReadWriteAccessor( rand, 'state', constantFunction( null ), noop ); - setReadOnly( rand, 'stateLength', null ); - setReadOnly( rand, 'byteLength', null ); - } else { - setReadOnlyAccessor( rand, 'seed', getSeed ); - setReadOnlyAccessor( rand, 'seedLength', getSeedLength ); - setReadWriteAccessor( rand, 'state', getState, setState ); - setReadOnlyAccessor( rand, 'stateLength', getStateLength ); - setReadOnlyAccessor( rand, 'byteLength', getStateSize ); - } - setReadOnly( rand, 'PRNG', prng.PRNG ); - return rand; - - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @private - * @param {NonNegativeInteger} len - array length - * @param {Options} [options] - function options - * @param {string} [options.dtype] - 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 - */ - function uniform1( len, options ) { - var ctor; - var out; - var err; - var dt; - var o; - if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( 'null2p', len ) ); - } - o = {}; - if ( arguments.length > 1 ) { - err = validate( o, options ); - if ( err ) { - throw err; - } - } - dt = o.dtype || opts.dtype; - if ( dt === 'generic' ) { - return filledBy( len, prng ); - } - ctor = ctors( dt ); - out = new ctor( len ); - nullary( [ out ], [ len ], [ 1 ], prng ); - return out; - } - - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @private - * @param {NonNegativeInteger} len - array length - * @param {number} a - minimum support - * @param {number} b - maximum support - * @param {Options} [options] - function options - * @param {string} [options.dtype] - 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 - */ - function uniform2( len, a, b, options ) { - var ctor; - var out; - var err; - var dt; - var o; - if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( 'null2p', len ) ); - } - o = {}; - if ( arguments.length > 3 ) { - err = validate( o, options ); - if ( err ) { - throw err; - } - } - // NOTE: we could alternatively use the PRNG factory function to create a PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. Decision made here to avoid this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom number. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in a return value of `NaN`. - dt = o.dtype || opts.dtype; - if ( dt === 'generic' ) { - return filledBy( len, wrapper ); - } - ctor = ctors( dt ); - out = new ctor( len ); - binary( [ [ a ], [ b ], out ], [ len ], [ 0, 0, 1 ], prng ); - return out; - - /** - * Applies parameters to a pseudorandom number generator function. - * - * @private - * @returns {number} pseudorandom number - */ - function wrapper() { - return prng( a, b ); - } - } - - /** - * Returns the PRNG seed. - * - * @private - * @returns {PRNGSeedMT19937} seed - */ - function getSeed() { - return rand.PRNG.seed; - } - - /** - * Returns the PRNG seed length. - * - * @private - * @returns {PositiveInteger} seed length - */ - function getSeedLength() { - return rand.PRNG.seedLength; - } - - /** - * Returns the PRNG state length. - * - * @private - * @returns {PositiveInteger} state length - */ - function getStateLength() { - return rand.PRNG.stateLength; - } - - /** - * Returns the PRNG state size (in bytes). - * - * @private - * @returns {PositiveInteger} state size (in bytes) - */ - function getStateSize() { - return rand.PRNG.byteLength; - } - - /** - * Returns the current pseudorandom number generator state. - * - * @private - * @returns {PRNGStateMT19937} current state - */ - function getState() { - return rand.PRNG.state; - } - - /** - * Sets the pseudorandom number generator state. - * - * @private - * @param {PRNGStateMT19937} s - generator state - * @throws {Error} must provide a valid state - */ - function setState( s ) { - rand.PRNG.state = s; - } -} - - -// EXPORTS // - -module.exports = factory; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 0077f00..0000000 --- a/lib/index.js +++ /dev/null @@ -1,77 +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'; - -/** -* Create an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. -* -* @module @stdlib/random-array-uniform -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var arr = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var arr = uniform( 10, 2.0, 5.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var rand = uniform.factory( 2.0, 5.0 ); -* // returns -* -* var arr = rand( 10 ); -* // returns -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var rand = uniform.factory( 2.0, 5.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" } diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index da0d9b1..0000000 --- a/lib/main.js +++ /dev/null @@ -1,58 +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 factory = require( './factory.js' ); - - -// MAIN // - -/** -* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. -* -* @name uniform -* @type {Function} -* @param {NonNegativeInteger} len - array length -* @param {number} a - minimum support -* @param {number} b - maximum support -* @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 = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var arr = uniform( 10, 2.0, 5.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -var uniform = factory(); - - -// EXPORTS // - -module.exports = uniform; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index 3629aaf..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,72 +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 dtypes = require( '@stdlib/array-typed-real-float-dtypes' ); -var isObject = require( '@stdlib/assert-is-plain-object' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// VARIABLES // - -var DTYPES = dtypes(); -DTYPES.push( 'generic' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Options} options - function options -* @param {string} [options.dtype] - output array data type -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var options = { -* 'dtype': 'float64' -* }; -* var err = validate( opts, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( 'null2h', options ) ); - } - if ( hasOwnProp( options, 'dtype' ) ) { - opts.dtype = options.dtype; - if ( DTYPES.indexOf( opts.dtype ) < 0 ) { - return new TypeError( format( 'null3t', 'dtype', DTYPES.join( '", "' ), opts.dtype ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index 8b6d28d..621da6a 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 continuous uniform 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,55 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-filled-by": "^0.0.2", - "@stdlib/array-typed-real-float-ctors": "^0.0.1", - "@stdlib/array-typed-real-float-dtypes": "^0.0.1", - "@stdlib/assert-has-own-property": "^0.0.7", - "@stdlib/assert-is-nonnegative-integer": "^0.0.7", - "@stdlib/assert-is-plain-object": "^0.0.7", - "@stdlib/random-base-uniform": "^0.0.6", - "@stdlib/strided-base-binary": "^0.0.8", - "@stdlib/strided-base-nullary": "^0.0.7", - "@stdlib/error-tools-fmtprodmsg": "^0.0.2", - "@stdlib/types": "^0.0.14", - "@stdlib/utils-constant-function": "^0.0.8", - "@stdlib/utils-define-nonenumerable-read-only-accessor": "^0.0.7", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.7", - "@stdlib/utils-define-nonenumerable-read-write-accessor": "^0.0.7", - "@stdlib/utils-noop": "^0.0.14" - }, - "devDependencies": { - "@stdlib/array-float32": "^0.0.6", - "@stdlib/array-float64": "^0.0.6", - "@stdlib/array-uint32": "^0.0.6", - "@stdlib/assert-is-uint32array": "^0.0.8", - "@stdlib/bench": "^0.0.12", - "@stdlib/console-log-each": "^0.0.2", - "@stdlib/constants-uint32-max": "^0.0.7", - "@stdlib/math-base-assert-is-nan": "^0.0.8", - "@stdlib/math-base-assert-is-nanf": "^0.0.8", - "@stdlib/math-base-special-pow": "^0.0.7", - "@stdlib/random-base-minstd": "^0.0.6", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdmath", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..59c1a1e --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/test.factory.js b/test/test.factory.js deleted file mode 100644 index a869e75..0000000 --- a/test/test.factory.js +++ /dev/null @@ -1,1328 +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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -tape( 'the function throws an error if the second distribution parameter is less than the first distribution parameter', function test( t ) { - var values; - var i; - - values = [ - [ 0.0, 0.0 ], - [ -2.0, -4.0 ], - [ 2.0, 1.0 ] - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( arr ) { - return function badValue() { - factory( arr[0], arr[1] ); - }; - } -}); - -tape( 'the function throws an error if the second distribution parameter is less than the first distribution parameter (options)', function test( t ) { - var values; - var i; - - values = [ - [ 0.0, 0.0 ], - [ -2.0, -4.0 ], - [ 2.0, 1.0 ] - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( arr ) { - return function badValue() { - factory( arr[0], arr[1], {} ); - }; - } -}); - -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, 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, { - '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, { - '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, { - '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, { - '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, { - '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, { - '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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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 ); - - 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 ); - - 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, { - '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 ); - - 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 ); - 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( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory(); - actual = random( 10, 2.0, 5.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( typeof actual[ i ], 'number', '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 ); - - 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 ); - - 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 ); - - 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 that generates `NaN` values if the first distribution parameter is greater than or equal to the second distribution parameter', function test( t ) { - var random; - var values; - var actual; - var i; - var j; - - random = factory(); - values = [ - [ 2.0, 1.0 ], - [ -3.0, -4.0 ], - [ 0.0, 0.0 ] - ]; - - for ( i = 0; i < values.length; i++ ) { - actual = random( 10, values[ i ][ 0 ], values[ i ][ 1 ] ); - for ( j = 0; j < actual.length; j++ ) { - t.strictEqual( isnan( actual[ j ] ), true, 'returns expected value when provided '+values[ 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, { - '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 ); - - 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, { - '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( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'float64' - }); - actual = random( 10, 2.0, 5.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( typeof actual[ i ], 'number', '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, { - '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( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'float32' - }); - actual = random( 10, 2.0, 5.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( typeof actual[ i ], 'number', '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, { - '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 ); - - 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, { - '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, { - '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 ); - - // 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, { - '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 ); - - // 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, { - '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 ); - - 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, { - 'prng': randu.normalized - }); - - randu = minstd.factory({ - 'seed': seed - }); - random2 = factory( 2.0, 5.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 ); - arr2 = random2( 10, 2.0, 5.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 c4fb6d3..0000000 --- a/test/test.js +++ /dev/null @@ -1,69 +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 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 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 37b0080..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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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, 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, { - '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 ); - - 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( typeof actual[ i ], 'number', '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, { - '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( typeof actual[ i ], 'number', '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, { - '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( typeof actual[ i ], 'number', '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, { - '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 ); - } - // Capture the current state: - state = random.state; - - // Move to a future state... - arr = random( 10, 2.0, 5.0 ); - for ( i = 0; i < 100; i++ ) { - random( 2, 2.0, 5.0 ); - } - // Set the state: - random.state = state; - - // Replay previously generated values: - t.deepEqual( random( 10, 2.0, 5.0 ), arr, 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.validate.js b/test/test.validate.js deleted file mode 100644 index c515526..0000000 --- a/test/test.validate.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 validate = require( './../lib/validate.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.equal( typeof validate, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function returns an error if provided an options argument which is not an object', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - void 0, - null, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, values[ i ] ); - t.equal( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided a `dtype` option which is not a supported data type', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - -5, - NaN, - true, - false, - void 0, - null, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, { - 'dtype': values[ i ] - }); - t.equal( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns null if all options are valid', function test( t ) { - var options; - var opts; - var err; - - options = { - 'dtype': 'float64' - }; - opts = {}; - err = validate( opts, options ); - - t.equal( err, null, 'returns null' ); - t.deepEqual( opts, options, 'sets option values' ); - - t.end(); -}); - -tape( 'the function ignores unrecognized/unsupported options', function test( t ) { - var options; - var opts; - var err; - - options = { - 'beep': true, - 'boop': 'bop' - }; - opts = {}; - err = validate( opts, options ); - - t.equal( err, null, 'returns null' ); - t.deepEqual( opts, {}, 'does not set any option values' ); - t.end(); -}); From 99dc47232f4a170e77d13267adeba1003de94861 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 8 Feb 2023 23:30:06 +0000 Subject: [PATCH 03/82] Transform error messages --- lib/factory.js | 6 +++--- lib/validate.js | 6 +++--- package.json | 2 +- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/lib/factory.js b/lib/factory.js index 22ec236..9f232af 100644 --- a/lib/factory.js +++ b/lib/factory.js @@ -31,7 +31,7 @@ var ctors = require( '@stdlib/array-typed-real-float-ctors' ); var filledBy = require( '@stdlib/array-base-filled-by' ); var nullary = require( '@stdlib/strided-base-nullary' ); var binary = require( '@stdlib/strided-base-binary' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -144,7 +144,7 @@ function factory() { var dt; var o; if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) ); + throw new TypeError( format( 'null2p', len ) ); } o = {}; if ( arguments.length > 1 ) { @@ -184,7 +184,7 @@ function factory() { var dt; var o; if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) ); + throw new TypeError( format( 'null2p', len ) ); } o = {}; if ( arguments.length > 3 ) { diff --git a/lib/validate.js b/lib/validate.js index 40b9723..3629aaf 100644 --- a/lib/validate.js +++ b/lib/validate.js @@ -23,7 +23,7 @@ var dtypes = require( '@stdlib/array-typed-real-float-dtypes' ); var isObject = require( '@stdlib/assert-is-plain-object' ); var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // VARIABLES // @@ -55,12 +55,12 @@ DTYPES.push( 'generic' ); */ function validate( opts, options ) { if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); + return new TypeError( format( 'null2h', options ) ); } if ( hasOwnProp( options, 'dtype' ) ) { opts.dtype = options.dtype; if ( DTYPES.indexOf( opts.dtype ) < 0 ) { - return new TypeError( format( 'invalid option. `%s` option must be one of the following: "%s". Option: `%s`.', 'dtype', DTYPES.join( '", "' ), opts.dtype ) ); + return new TypeError( format( 'null3t', 'dtype', DTYPES.join( '", "' ), opts.dtype ) ); } } return null; diff --git a/package.json b/package.json index 486f4d2..8b6d28d 100644 --- a/package.json +++ b/package.json @@ -46,7 +46,7 @@ "@stdlib/random-base-uniform": "^0.0.6", "@stdlib/strided-base-binary": "^0.0.8", "@stdlib/strided-base-nullary": "^0.0.7", - "@stdlib/string-format": "^0.0.3", + "@stdlib/error-tools-fmtprodmsg": "^0.0.2", "@stdlib/types": "^0.0.14", "@stdlib/utils-constant-function": "^0.0.8", "@stdlib/utils-define-nonenumerable-read-only-accessor": "^0.0.7", From de7dbaf57cd4d32519dbd44181ca2acfc2b8b6e4 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 8 Feb 2023 23:30:48 +0000 Subject: [PATCH 04/82] Remove files --- index.d.ts | 245 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6427 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 cf23637..0000000 --- a/index.d.ts +++ /dev/null @@ -1,245 +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. -*/ - -// TypeScript Version: 2.0 - -/// - -import { FloatDataType, FloatTypedArray } from '@stdlib/types/array'; -import * as random from '@stdlib/types/random'; - -/** -* Supported data types. -*/ -type DataType = FloatDataType | 'generic'; - -/** -* 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 { - /** - * Default output array data type. Default: 'float64'. - */ - 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 uniformly distributed pseudorandom numbers with pre-specified parameter values. -*/ -interface UnaryFunction extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @param len - array length - * @param options - function options - * @returns output array - */ - ( len: number, options?: Options ): RandomArray; -} - -/** -* Interface for generating uniformly distributed pseudorandom numbers without pre-specified parameter values. -*/ -interface TernaryFunction extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @param len - array length - * @param a - minimum support - * @param b - maximum support - * @param options - function options - * @returns output array - */ - ( len: number, a: number, b: number, options?: Options ): RandomArray; -} - -/** -* Interface for generating pseudorandom numbers drawn from a uniform distribution. -*/ -interface Random extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @param len - array length - * @param a - minimum support - * @param b - maximum support - * @param options - function options - * @returns output array - * - * @example - * var out = uniform( 10, 2.0, 5.0 ); - * // returns - */ - ( len: number, a: number, b: number, options?: Options ): RandomArray; - - /** - * Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution. - * - * ## Notes - * - * - When provided `a` and `b`, the returned function returns random variates drawn from the specified distribution. - * - * @param a - minimum support - * @param b - maximum support - * @param options - function options - * @throws `a` must be less than `b` - * @throws must provide a valid state - * @returns function for creating arrays - * - * @example - * var random = uniform.factory( 2.0, 5.0 ); - * - * var out = random( 10 ); - * // returns - * - * @example - * var random = uniform.factory( 2.0, 5.0, { - * 'seed': 297 - * }); - * var out = random( 10 ); - * // returns - */ - factory( a: number, b: number, options?: FactoryOptions ): UnaryFunction; - - /** - * Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution. - * - * ## Notes - * - * - When not provided `a` and `b`, the returned function requires that both `a` and `b` be provided at each invocation. - * - * @param options - function options - * @throws must provide a valid state - * @returns function for creating arrays - * - * @example - * var random = uniform.factory(); - * - * var out = random( 10, 2.0, 5.0 ); - * // returns - * - * @example - * var random = uniform.factory({ - * 'seed': 297 - * }); - * var out = random( 10, 2.0, 5.0 ); - * // returns - */ - factory( options?: FactoryOptions ): TernaryFunction; -} - -/** -* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. -* -* @param len - array length -* @param a - minimum support -* @param b - maximum support -* @param options - function options -* @returns output array -* -* @example -* var out = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var random = uniform.factory( 2.0, 5.0 ); -* -* var out = random( 10 ); -* // returns -*/ -declare var uniform: Random; - - -// EXPORTS // - -export = uniform; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index a4cb981..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-accessor@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-write-accessor@esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-constant-function@esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-noop@v0.0.14-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/random-base-uniform@esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-typed-real-float-ctors@esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-nullary@esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@esm/index.mjs";import f from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.0.2-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/array-typed-real-float-dtypes@esm/index.mjs";import h from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@esm/index.mjs";var u="float64",c=a();function y(e,t){return h(t)?j(t,"dtype")&&(e.dtype=t.dtype,c.indexOf(e.dtype)<0)?new TypeError(f("null3t","dtype",c.join('", "'),e.dtype)):null:new TypeError(f("null2h",t))}function g(){var a,h,j,c,g,b;if(j={dtype:u},0===(h=arguments.length))g=d,c=x;else if(1===h){if(a=arguments[0],g=d.factory(a),b=y(j,a))throw b;c=x}else if(2===h)g=d.factory(arguments[0],arguments[1]),c=v;else if(3===h){if(a=arguments[2],g=d.factory(arguments[0],arguments[1],a),b=y(j,a))throw b;c=v}return a&&a.prng?(e(c,"seed",null),e(c,"seedLength",null),s(c,"state",r(null),i),e(c,"stateLength",null),e(c,"byteLength",null)):(n(c,"seed",w),n(c,"seedLength",L),s(c,"state",P,R),n(c,"stateLength",G),n(c,"byteLength",N)),e(c,"PRNG",g.PRNG),c;function v(e,n){var s,r,i,d;if(!t(e))throw new TypeError(f("null2p",e));if(d={},arguments.length>1&&(r=y(d,n)))throw r;return"generic"===(i=d.dtype||j.dtype)?l(e,g):(s=new(o(i))(e),m([s],[e],[1],g),s)}function x(e,n,s,r){var i,d,m,a;if(!t(e))throw new TypeError(f("null2p",e));if(a={},arguments.length>3&&(d=y(a,r)))throw d;return"generic"===(m=a.dtype||j.dtype)?l(e,h):(i=new(o(m))(e),p([[n],[s],i],[e],[0,0,1],g),i);function h(){return g(n,s)}}function w(){return c.PRNG.seed}function L(){return c.PRNG.seedLength}function G(){return c.PRNG.stateLength}function N(){return c.PRNG.byteLength}function P(){return c.PRNG.state}function R(e){c.PRNG.state=e}}c.push("generic");var b=g();e(b,"factory",g);export{b as default,g as factory}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 4984bd1..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/factory.js","../lib/main.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 dtypes from '@stdlib/array-typed-real-float-dtypes';\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes();\nDTYPES.push( 'generic' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( 'null2h', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( DTYPES.indexOf( opts.dtype ) < 0 ) {\n\t\t\treturn new TypeError( format( 'null3t', 'dtype', DTYPES.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport setReadOnlyAccessor from '@stdlib/utils-define-nonenumerable-read-only-accessor';\nimport setReadWriteAccessor from '@stdlib/utils-define-nonenumerable-read-write-accessor';\nimport constantFunction from '@stdlib/utils-constant-function';\nimport noop from '@stdlib/utils-noop';\nimport base from '@stdlib/random-base-uniform';\nimport ctors from '@stdlib/array-typed-real-float-ctors';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport nullary from '@stdlib/strided-base-nullary';\nimport binary from '@stdlib/strided-base-binary';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution.\n*\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\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 {RangeError} `a` must be less than `b`\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 uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10 );\n* // returns \n*\n* @example\n* var uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nfunction factory() {\n\tvar options;\n\tvar nargs;\n\tvar opts;\n\tvar rand;\n\tvar prng;\n\tvar err;\n\n\topts = {\n\t\t'dtype': defaults.dtype\n\t};\n\n\tnargs = arguments.length;\n\tif ( nargs === 0 ) {\n\t\tprng = base;\n\t\trand = uniform2;\n\t} else if ( nargs === 1 ) {\n\t\toptions = arguments[ 0 ];\n\t\tprng = base.factory( options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform2;\n\t} else if ( nargs === 2 ) {\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ] );\n\t\trand = uniform1;\n\t} else if ( nargs === 3 ) {\n\t\toptions = arguments[ 2 ];\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ], options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform1;\n\t}\n\tif ( options && options.prng ) {\n\t\tsetReadOnly( rand, 'seed', null );\n\t\tsetReadOnly( rand, 'seedLength', null );\n\t\tsetReadWriteAccessor( rand, 'state', constantFunction( null ), noop );\n\t\tsetReadOnly( rand, 'stateLength', null );\n\t\tsetReadOnly( rand, 'byteLength', null );\n\t} else {\n\t\tsetReadOnlyAccessor( rand, 'seed', getSeed );\n\t\tsetReadOnlyAccessor( rand, 'seedLength', getSeedLength );\n\t\tsetReadWriteAccessor( rand, 'state', getState, setState );\n\t\tsetReadOnlyAccessor( rand, 'stateLength', getStateLength );\n\t\tsetReadOnlyAccessor( rand, 'byteLength', getStateSize );\n\t}\n\tsetReadOnly( rand, 'PRNG', prng.PRNG );\n\treturn rand;\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform1( len, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( 'null2p', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 1 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, prng );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tnullary( [ out ], [ len ], [ 1 ], prng );\n\t\treturn out;\n\t}\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {number} a - minimum support\n\t* @param {number} b - maximum support\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform2( len, a, b, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( 'null2p', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 3 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\t// NOTE: we could alternatively use the PRNG factory function to create a PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. Decision made here to avoid this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom number. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in a return value of `NaN`.\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, wrapper );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tbinary( [ [ a ], [ b ], out ], [ len ], [ 0, 0, 1 ], prng );\n\t\treturn out;\n\n\t\t/**\n\t\t* Applies parameters to a pseudorandom number generator function.\n\t\t*\n\t\t* @private\n\t\t* @returns {number} pseudorandom number\n\t\t*/\n\t\tfunction wrapper() {\n\t\t\treturn prng( a, b );\n\t\t}\n\t}\n\n\t/**\n\t* Returns the PRNG seed.\n\t*\n\t* @private\n\t* @returns {PRNGSeedMT19937} seed\n\t*/\n\tfunction getSeed() {\n\t\treturn rand.PRNG.seed;\n\t}\n\n\t/**\n\t* Returns the PRNG seed length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} seed length\n\t*/\n\tfunction getSeedLength() {\n\t\treturn rand.PRNG.seedLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state length\n\t*/\n\tfunction getStateLength() {\n\t\treturn rand.PRNG.stateLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state size (in bytes).\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state size (in bytes)\n\t*/\n\tfunction getStateSize() {\n\t\treturn rand.PRNG.byteLength;\n\t}\n\n\t/**\n\t* Returns the current pseudorandom number generator state.\n\t*\n\t* @private\n\t* @returns {PRNGStateMT19937} current state\n\t*/\n\tfunction getState() {\n\t\treturn rand.PRNG.state;\n\t}\n\n\t/**\n\t* Sets the pseudorandom number generator state.\n\t*\n\t* @private\n\t* @param {PRNGStateMT19937} s - generator state\n\t* @throws {Error} must provide a valid state\n\t*/\n\tfunction setState( s ) {\n\t\trand.PRNG.state = s;\n\t}\n}\n\n\n// EXPORTS //\n\nexport default factory;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @name uniform\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\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 = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar uniform = factory();\n\n\n// EXPORTS //\n\nexport default uniform;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @module @stdlib/random-array-uniform\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.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\" }\n"],"names":["DTYPES","dtypes","validate","opts","options","isObject","hasOwnProp","dtype","indexOf","TypeError","format","join","factory","nargs","rand","prng","err","defaults","arguments","length","base","uniform2","uniform1","setReadOnly","setReadWriteAccessor","constantFunction","noop","setReadOnlyAccessor","getSeed","getSeedLength","getState","setState","getStateLength","getStateSize","PRNG","len","out","dt","o","isNonNegativeInteger","filledBy","ctors","nullary","a","b","wrapper","binary","seed","seedLength","stateLength","byteLength","state","s","push","uniform","main"],"mappings":";;07CA8BIA,EAASC,IAyBb,SAASC,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,WACzBD,EAAKI,MAAQH,EAAQG,MAChBP,EAAOQ,QAASL,EAAKI,OAAU,GAC5B,IAAIE,UAAWC,EAAQ,SAAU,QAASV,EAAOW,KAAM,QAAUR,EAAKI,QAGxE,KARC,IAAIE,UAAWC,EAAQ,SAAUN,GAS1C,CCSA,SAASQ,IACR,IAAIR,EACAS,EACAV,EACAW,EACAC,EACAC,EAOJ,GALAb,EAAO,CACNI,MAASU,GAIK,KADfJ,EAAQK,UAAUC,QAEjBJ,EAAOK,EACPN,EAAOO,OACD,GAAe,IAAVR,EAAc,CAIzB,GAHAT,EAAUc,UAAW,GACrBH,EAAOK,EAAKR,QAASR,GACrBY,EAAMd,EAAUC,EAAMC,GAErB,MAAMY,EAEPF,EAAOO,CACT,MAAQ,GAAe,IAAVR,EACXE,EAAOK,EAAKR,QAASM,UAAW,GAAKA,UAAW,IAChDJ,EAAOQ,OACD,GAAe,IAAVT,EAAc,CAIzB,GAHAT,EAAUc,UAAW,GACrBH,EAAOK,EAAKR,QAASM,UAAW,GAAKA,UAAW,GAAKd,GACrDY,EAAMd,EAAUC,EAAMC,GAErB,MAAMY,EAEPF,EAAOQ,CACP,CAeD,OAdKlB,GAAWA,EAAQW,MACvBQ,EAAaT,EAAM,OAAQ,MAC3BS,EAAaT,EAAM,aAAc,MACjCU,EAAsBV,EAAM,QAASW,EAAkB,MAAQC,GAC/DH,EAAaT,EAAM,cAAe,MAClCS,EAAaT,EAAM,aAAc,QAEjCa,EAAqBb,EAAM,OAAQc,GACnCD,EAAqBb,EAAM,aAAce,GACzCL,EAAsBV,EAAM,QAASgB,EAAUC,GAC/CJ,EAAqBb,EAAM,cAAekB,GAC1CL,EAAqBb,EAAM,aAAcmB,IAE1CV,EAAaT,EAAM,OAAQC,EAAKmB,MACzBpB,EAcP,SAASQ,EAAUa,EAAK/B,GACvB,IACIgC,EACApB,EACAqB,EACAC,EACJ,IAAMC,EAAsBJ,GAC3B,MAAM,IAAI1B,UAAWC,EAAQ,SAAUyB,IAGxC,GADAG,EAAI,CAAA,EACCpB,UAAUC,OAAS,IACvBH,EAAMd,EAAUoC,EAAGlC,IAElB,MAAMY,EAIR,MAAY,aADZqB,EAAKC,EAAE/B,OAASJ,EAAKI,OAEbiC,EAAUL,EAAKpB,IAGvBqB,EAAM,IADCK,EAAOJ,GACR,CAAUF,GAChBO,EAAS,CAAEN,GAAO,CAAED,GAAO,CAAE,GAAKpB,GAC3BqB,EACP,CAgBD,SAASf,EAAUc,EAAKQ,EAAGC,EAAGxC,GAC7B,IACIgC,EACApB,EACAqB,EACAC,EACJ,IAAMC,EAAsBJ,GAC3B,MAAM,IAAI1B,UAAWC,EAAQ,SAAUyB,IAGxC,GADAG,EAAI,CAAA,EACCpB,UAAUC,OAAS,IACvBH,EAAMd,EAAUoC,EAAGlC,IAElB,MAAMY,EAKR,MAAY,aADZqB,EAAKC,EAAE/B,OAASJ,EAAKI,OAEbiC,EAAUL,EAAKU,IAGvBT,EAAM,IADCK,EAAOJ,GACR,CAAUF,GAChBW,EAAQ,CAAE,CAAEH,GAAK,CAAEC,GAAKR,GAAO,CAAED,GAAO,CAAE,EAAG,EAAG,GAAKpB,GAC9CqB,GAQP,SAASS,IACR,OAAO9B,EAAM4B,EAAGC,EAChB,CACD,CAQD,SAAShB,IACR,OAAOd,EAAKoB,KAAKa,IACjB,CAQD,SAASlB,IACR,OAAOf,EAAKoB,KAAKc,UACjB,CAQD,SAAShB,IACR,OAAOlB,EAAKoB,KAAKe,WACjB,CAQD,SAAShB,IACR,OAAOnB,EAAKoB,KAAKgB,UACjB,CAQD,SAASpB,IACR,OAAOhB,EAAKoB,KAAKiB,KACjB,CASD,SAASpB,EAAUqB,GAClBtC,EAAKoB,KAAKiB,MAAQC,CAClB,CACF,CDrPApD,EAAOqD,KAAM,WEqBV,IAACC,EAAU1C,ICiBdW,EAAAgC,EAAA,UAAA3C"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 59c1a1e..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 9f445fb752223a2eb8152dad9caf1cc05a11d81d Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 8 Feb 2023 23:32:22 +0000 Subject: [PATCH 05/82] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 62 - .github/workflows/cancel.yml | 56 - .github/workflows/close_pull_requests.yml | 44 - .github/workflows/examples.yml | 62 - .github/workflows/npm_downloads.yml | 108 - .github/workflows/productionize.yml | 798 --- .github/workflows/publish.yml | 236 - .github/workflows/test.yml | 97 - .github/workflows/test_bundles.yml | 180 - .github/workflows/test_coverage.yml | 123 - .github/workflows/test_install.yml | 83 - .gitignore | 184 - .npmignore | 227 - .npmrc | 28 - CHANGELOG.md | 5 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 61 +- benchmark/benchmark.float32.factory.js | 96 - benchmark/benchmark.float32.js | 98 - benchmark/benchmark.float64.factory.js | 96 - benchmark/benchmark.float64.js | 98 - benchmark/benchmark.generic.factory.js | 96 - benchmark/benchmark.generic.js | 98 - branches.md | 53 - docs/repl.txt | 192 - docs/types/test.ts | 355 -- examples/index.js | 48 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/defaults.json | 3 - lib/factory.js | 282 - lib/index.js | 77 - lib/main.js | 58 - lib/validate.js | 72 - package.json | 76 +- stats.html | 6177 +++++++++++++++++++++ test/test.factory.js | 1328 ----- test/test.js | 69 - test/test.main.js | 244 - test/test.validate.js | 118 - 47 files changed, 6215 insertions(+), 6658 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 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 benchmark/benchmark.float32.factory.js delete mode 100644 benchmark/benchmark.float32.js delete mode 100644 benchmark/benchmark.float64.factory.js delete mode 100644 benchmark/benchmark.float64.js delete mode 100644 benchmark/benchmark.generic.factory.js delete mode 100644 benchmark/benchmark.generic.js delete mode 100644 branches.md 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/defaults.json delete mode 100644 lib/factory.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/test.factory.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js delete mode 100644 test/test.validate.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 0fd4d6c..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 `tslint.json` files: -[tslint.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 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 c4ab52b..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/uniform) 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 06a9a75..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,62 +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' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 a00dbe5..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,56 +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' - uses: styfle/cancel-workflow-action@0.11.0 - 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 7eca213..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,44 +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: - run: - runs-on: ubuntu-latest - steps: - - uses: superbrothers/close-pull-request@v3 - 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/uniform) 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 7902a7d..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,62 +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 the repository: - - name: 'Checkout the repository' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 818b9df..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,108 +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: '33 9 * * 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' - uses: actions/checkout@v3 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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' - uses: actions/upload-artifact@v3 - 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' - uses: distributhor/workflow-webhook@v3 - 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 3e8e2db..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,798 +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' - uses: actions/checkout@v3 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 - - # Format error messages: - - name: 'Replace double quotes with single quotes in rewritten format string error messages' - run: | - find . -name "*.js" -exec sed -E -i "s/Error\( format\( \"([a-zA-Z0-9]+)\"/Error\( format\( '\1'/g" {} \; - - # Format string literal error messages: - - name: 'Replace double quotes with single quotes in rewritten string literal error messages' - run: | - find . -name "*.js" -exec sed -E -i "s/Error\( format\(\"([a-zA-Z0-9]+)\"\)/Error\( format\( '\1' \)/g" {} \; - - # Format code: - - name: 'Replace double quotes with single quotes in inserted `require` calls' - run: | - find . -name "*.js" -exec sed -E -i "s/require\( ?\"@stdlib\/error-tools-fmtprodmsg\" ?\);/require\( '@stdlib\/error-tools-fmtprodmsg' \);/g" {} \; - - # 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' }} - uses: actions/checkout@v3 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - uses: actions/setup-node@v3 - with: - node-version: 16 - 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' - uses: actions/checkout@v3 - - # 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' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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' - uses: act10ns/slack@v1 - 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' - uses: actions/checkout@v3 - - # 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' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 + + ```
@@ -364,7 +363,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]. @@ -424,13 +423,13 @@ Copyright © 2016-2023. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/random-array-uniform/main/LICENSE -[@stdlib/random/base/uniform]: https://github.com/stdlib-js/random-base-uniform +[@stdlib/random/base/uniform]: https://github.com/stdlib-js/random-base-uniform/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/benchmark/benchmark.float32.factory.js b/benchmark/benchmark.float32.factory.js deleted file mode 100644 index 67e61f4..0000000 --- a/benchmark/benchmark.float32.factory.js +++ /dev/null @@ -1,96 +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 bench = require( '@stdlib/bench' ); -var isnanf = require( '@stdlib/math-base-assert-is-nanf' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var fcn = uniform.factory( 2.0, 5.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 4642816..0000000 --- a/benchmark/benchmark.float32.js +++ /dev/null @@ -1,98 +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 bench = require( '@stdlib/bench' ); -var isnanf = require( '@stdlib/math-base-assert-is-nanf' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = 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 = uniform( len, 2.0, 5.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.factory.js b/benchmark/benchmark.float64.factory.js deleted file mode 100644 index 8646a54..0000000 --- a/benchmark/benchmark.float64.factory.js +++ /dev/null @@ -1,96 +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 bench = require( '@stdlib/bench' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var fcn = uniform.factory( 2.0, 5.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 5ee0d97..0000000 --- a/benchmark/benchmark.float64.js +++ /dev/null @@ -1,98 +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 bench = require( '@stdlib/bench' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = 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 = uniform( len, 2.0, 5.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.factory.js b/benchmark/benchmark.generic.factory.js deleted file mode 100644 index 7020d62..0000000 --- a/benchmark/benchmark.generic.factory.js +++ /dev/null @@ -1,96 +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 bench = require( '@stdlib/bench' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var fcn = uniform.factory( 2.0, 5.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 06a2a83..0000000 --- a/benchmark/benchmark.generic.js +++ /dev/null @@ -1,98 +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 bench = require( '@stdlib/bench' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = 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 = uniform( len, 2.0, 5.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 30542fb..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/uniform" -%% click B href "https://github.com/stdlib-js/random-array-uniform/tree/main" -%% click C href "https://github.com/stdlib-js/random-array-uniform/tree/production" -%% click D href "https://github.com/stdlib-js/random-array-uniform/tree/esm" -%% click E href "https://github.com/stdlib-js/random-array-uniform/tree/deno" -%% click F href "https://github.com/stdlib-js/random-array-uniform/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/uniform -[production-url]: https://github.com/stdlib-js/random-array-uniform/tree/production -[deno-url]: https://github.com/stdlib-js/random-array-uniform/tree/deno -[umd-url]: https://github.com/stdlib-js/random-array-uniform/tree/umd -[esm-url]: https://github.com/stdlib-js/random-array-uniform/tree/esm \ No newline at end of file diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 6ecb862..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,192 +0,0 @@ - -{{alias}}( len, a, b[, options] ) - Returns an array containing pseudorandom numbers drawn from a continuous - uniform distribution. - - Parameters - ---------- - len: integer - Output array length. - - a: number - Minimum support. - - b: number - Maximum support. - - 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) - Output array data type. Default: 'float64'. - - Returns - ------- - out: Array|Float64Array|Float32Array - Output array. - - Examples - -------- - > var out = {{alias}}( 3, 2.0, 5.0 ) - - - -{{alias}}.factory( [a, b, ][options] ) - Returns a function for creating arrays containing pseudorandom numbers drawn - from a continuous uniform distribution. - - If provided `a` and `b`, the returned function returns random variates drawn - from the specified distribution. - - If not provided `a` and `b`, the returned function requires that both `a` - and `b` 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. - - 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 ) - - - // Provide `a` and `b`: - > fcn = {{alias}}.factory( 2.0, 5.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 ) - - - // Get a copy of the current state: - > var state = {{alias}}.state - - - > out = {{alias}}( 3, 2.0, 5.0 ) - - > out = {{alias}}( 3, 2.0, 5.0 ) - - - // Set the state: - > {{alias}}.state = state; - - // Regenerate a previous array: - > out = {{alias}}( 3, 2.0, 5.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 09805a0..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,355 +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. -*/ - -import uniform = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - uniform( 10, 2, 3 ); // $ExpectType RandomArray - uniform( 10, 1, 2 ); // $ExpectType RandomArray - uniform( 10, 1, 2, {} ); // $ExpectType RandomArray -} - -// The compiler throws an error if the function is provided a first argument which is not a number... -{ - uniform( '5', 2.0, 5.0 ); // $ExpectError - uniform( true, 2.0, 5.0 ); // $ExpectError - uniform( false, 2.0, 5.0 ); // $ExpectError - uniform( null, 2.0, 5.0 ); // $ExpectError - uniform( [], 2.0, 5.0 ); // $ExpectError - uniform( {}, 2.0, 5.0 ); // $ExpectError - uniform( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - uniform( '5', 2.0, 5.0, {} ); // $ExpectError - uniform( true, 2.0, 5.0, {} ); // $ExpectError - uniform( false, 2.0, 5.0, {} ); // $ExpectError - uniform( null, 2.0, 5.0, {} ); // $ExpectError - uniform( [], 2.0, 5.0, {} ); // $ExpectError - uniform( {}, 2.0, 5.0, {} ); // $ExpectError - uniform( ( x: number ): number => x, 2.0, 5.0, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a number... -{ - uniform( 10, '5', 5.0 ); // $ExpectError - uniform( 10, true, 5.0 ); // $ExpectError - uniform( 10, false, 5.0 ); // $ExpectError - uniform( 10, null, 5.0 ); // $ExpectError - uniform( 10, [], 5.0 ); // $ExpectError - uniform( 10, {}, 5.0 ); // $ExpectError - uniform( 10, ( x: number ): number => x, 5.0 ); // $ExpectError - - uniform( 10, '5', 5.0, {} ); // $ExpectError - uniform( 10, true, 5.0, {} ); // $ExpectError - uniform( 10, false, 5.0, {} ); // $ExpectError - uniform( 10, null, 5.0, {} ); // $ExpectError - uniform( 10, [], 5.0, {} ); // $ExpectError - uniform( 10, {}, 5.0, {} ); // $ExpectError - uniform( 10, ( x: number ): number => x, 5.0, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a number... -{ - uniform( 10, 2.0, '5' ); // $ExpectError - uniform( 10, 2.0, true ); // $ExpectError - uniform( 10, 2.0, false ); // $ExpectError - uniform( 10, 2.0, null ); // $ExpectError - uniform( 10, 2.0, [] ); // $ExpectError - uniform( 10, 2.0, {} ); // $ExpectError - uniform( 10, 2.0, ( x: number ): number => x ); // $ExpectError - - uniform( 10, 2.0, '5', {} ); // $ExpectError - uniform( 10, 2.0, true, {} ); // $ExpectError - uniform( 10, 2.0, false, {} ); // $ExpectError - uniform( 10, 2.0, null, {} ); // $ExpectError - uniform( 10, 2.0, [], {} ); // $ExpectError - uniform( 10, 2.0, {}, {} ); // $ExpectError - uniform( 10, 2.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... -{ - uniform( 10, 2.0, 5.0, '5' ); // $ExpectError - uniform( 10, 2.0, 5.0, 5 ); // $ExpectError - uniform( 10, 2.0, 5.0, true ); // $ExpectError - uniform( 10, 2.0, 5.0, false ); // $ExpectError - uniform( 10, 2.0, 5.0, [] ); // $ExpectError - uniform( 10, 2.0, 5.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... -{ - uniform( 10, 2.0, 5.0, { 'dtype': 123 } ); // $ExpectError - uniform( 10, 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - uniform( 10, 2.0, 5.0, { 'dtype': null } ); // $ExpectError - uniform( 10, 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - uniform( 10, 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - uniform( 10, 2.0, 5.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - uniform(); // $ExpectError - uniform( 10 ); // $ExpectError - uniform( 10, 2.0 ); // $ExpectError - uniform( 10, 2.0, 5.0, {}, {} ); // $ExpectError -} - -// Attached to main export is a `factory` method which returns a function... -{ - uniform.factory( 2.0, 5.0 ); // $ExpectType UnaryFunction - uniform.factory( 2.0, 5.0, { 'copy': false } ); // $ExpectType UnaryFunction - - uniform.factory(); // $ExpectType TernaryFunction - uniform.factory( { 'copy': false } ); // $ExpectType TernaryFunction -} - -// The `factory` method returns a function which returns an array... -{ - const fcn1 = uniform.factory( 2.0, 5.0 ); - fcn1( 10, ); // $ExpectType RandomArray - - const fcn2 = uniform.factory(); - fcn2( 10, 2.0, 5.0 ); // $ExpectType RandomArray -} - -// The compiler throws an error if the `factory` method is provided invalid arguments... -{ - uniform.factory( '5', 5.0 ); // $ExpectError - uniform.factory( true, 5.0 ); // $ExpectError - uniform.factory( false, 5.0 ); // $ExpectError - uniform.factory( [], 5.0 ); // $ExpectError - uniform.factory( {}, 5.0 ); // $ExpectError - uniform.factory( ( x: number ): number => x, 5.0 ); // $ExpectError - - uniform.factory( '5', 5.0, {} ); // $ExpectError - uniform.factory( true, 5.0, {} ); // $ExpectError - uniform.factory( false, 5.0, {} ); // $ExpectError - uniform.factory( [], 5.0, {} ); // $ExpectError - uniform.factory( {}, 5.0, {} ); // $ExpectError - uniform.factory( ( x: number ): number => x, 5.0, {} ); // $ExpectError - - uniform.factory( 2.0, '5' ); // $ExpectError - uniform.factory( 2.0, true ); // $ExpectError - uniform.factory( 2.0, false ); // $ExpectError - uniform.factory( 2.0, [] ); // $ExpectError - uniform.factory( 2.0, {} ); // $ExpectError - uniform.factory( 2.0, ( x: number ): number => x ); // $ExpectError - - uniform.factory( 2.0, '5', {} ); // $ExpectError - uniform.factory( 2.0, true, {} ); // $ExpectError - uniform.factory( 2.0, false, {} ); // $ExpectError - uniform.factory( 2.0, [], {} ); // $ExpectError - uniform.factory( 2.0, {}, {} ); // $ExpectError - uniform.factory( 2.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... -{ - uniform.factory( null ); // $ExpectError - uniform.factory( 2.0, 5.0, null ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided a `prng` option which is not a pseudorandom number generator... -{ - uniform.factory( 2.0, 5.0, { 'prng': 123 } ); // $ExpectError - uniform.factory( 2.0, 5.0, { 'prng': 'abc' } ); // $ExpectError - uniform.factory( 2.0, 5.0, { 'prng': null } ); // $ExpectError - uniform.factory( 2.0, 5.0, { 'prng': [] } ); // $ExpectError - uniform.factory( 2.0, 5.0, { 'prng': {} } ); // $ExpectError - uniform.factory( 2.0, 5.0, { 'prng': true ); // $ExpectError - - uniform.factory( { 'prng': 123 } ); // $ExpectError - uniform.factory( { 'prng': 'abc' } ); // $ExpectError - uniform.factory( { 'prng': null } ); // $ExpectError - uniform.factory( { 'prng': [] } ); // $ExpectError - uniform.factory( { 'prng': {} } ); // $ExpectError - uniform.factory( { 'prng': true ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided a `seed` option which is not a valid seed... -{ - uniform.factory( 2.0, 5.0, { 'seed': true } ); // $ExpectError - uniform.factory( 2.0, 5.0, { 'seed': 'abc' } ); // $ExpectError - uniform.factory( 2.0, 5.0, { 'seed': null } ); // $ExpectError - uniform.factory( 2.0, 5.0, { 'seed': [ 'a' ] } ); // $ExpectError - uniform.factory( 2.0, 5.0, { 'seed': {} } ); // $ExpectError - uniform.factory( 2.0, 5.0, { 'seed': ( x: number ): number => x } ); // $ExpectError - - uniform.factory( { 'seed': true } ); // $ExpectError - uniform.factory( { 'seed': 'abc' } ); // $ExpectError - uniform.factory( { 'seed': null } ); // $ExpectError - uniform.factory( { 'seed': [ 'a' ] } ); // $ExpectError - uniform.factory( { 'seed': {} } ); // $ExpectError - uniform.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... -{ - uniform.factory( 2.0, 5.0, { 'state': 123 } ); // $ExpectError - uniform.factory( 2.0, 5.0, { 'state': 'abc' } ); // $ExpectError - uniform.factory( 2.0, 5.0, { 'state': null } ); // $ExpectError - uniform.factory( 2.0, 5.0, { 'state': [] } ); // $ExpectError - uniform.factory( 2.0, 5.0, { 'state': {} } ); // $ExpectError - uniform.factory( 2.0, 5.0, { 'state': true ); // $ExpectError - uniform.factory( 2.0, 5.0, { 'state': ( x: number ): number => x } ); // $ExpectError - - uniform.factory( { 'state': 123 } ); // $ExpectError - uniform.factory( { 'state': 'abc' } ); // $ExpectError - uniform.factory( { 'state': null } ); // $ExpectError - uniform.factory( { 'state': [] } ); // $ExpectError - uniform.factory( { 'state': {} } ); // $ExpectError - uniform.factory( { 'state': true ); // $ExpectError - uniform.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... -{ - uniform.factory( 2.0, 5.0, { 'copy': 123 } ); // $ExpectError - uniform.factory( 2.0, 5.0, { 'copy': 'abc' } ); // $ExpectError - uniform.factory( 2.0, 5.0, { 'copy': null } ); // $ExpectError - uniform.factory( 2.0, 5.0, { 'copy': [] } ); // $ExpectError - uniform.factory( 2.0, 5.0, { 'copy': {} } ); // $ExpectError - uniform.factory( 2.0, 5.0, { 'copy': ( x: number ): number => x } ); // $ExpectError - - uniform.factory( { 'copy': 123 } ); // $ExpectError - uniform.factory( { 'copy': 'abc' } ); // $ExpectError - uniform.factory( { 'copy': null } ); // $ExpectError - uniform.factory( { 'copy': [] } ); // $ExpectError - uniform.factory( { 'copy': {} } ); // $ExpectError - uniform.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... -{ - uniform.factory( 2.0, 5.0, { 'dtype': 123 } ); // $ExpectError - uniform.factory( 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - uniform.factory( 2.0, 5.0, { 'dtype': null } ); // $ExpectError - uniform.factory( 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - uniform.factory( 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - uniform.factory( 2.0, 5.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError - - uniform.factory( { 'dtype': 123 } ); // $ExpectError - uniform.factory( { 'dtype': 'abc' } ); // $ExpectError - uniform.factory( { 'dtype': null } ); // $ExpectError - uniform.factory( { 'dtype': [] } ); // $ExpectError - uniform.factory( { 'dtype': {} } ); // $ExpectError - uniform.factory( { 'dtype': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided more than three arguments... -{ - uniform.factory( 2.0, 5.0, {}, {} ); // $ExpectError -} - -// The compiler throws an error if the function returned by the `factory` method is provided invalid arguments... -{ - const fcn1 = uniform.factory( 2.0, 5.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 = uniform.factory(); - fcn2( true, 2.0, 5.0 ); // $ExpectError - fcn2( false, 2.0, 5.0 ); // $ExpectError - fcn2( '5', 2.0, 5.0 ); // $ExpectError - fcn2( [], 2.0, 5.0 ); // $ExpectError - fcn2( {}, 2.0, 5.0 ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - fcn2( true, 2.0, 5.0, {} ); // $ExpectError - fcn2( false, 2.0, 5.0, {} ); // $ExpectError - fcn2( '5', 2.0, 5.0, {} ); // $ExpectError - fcn2( [], 2.0, 5.0, {} ); // $ExpectError - fcn2( {}, 2.0, 5.0, {} ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0, {} ); // $ExpectError - - fcn2( 10, true, 5.0 ); // $ExpectError - fcn2( 10, false, 5.0 ); // $ExpectError - fcn2( 10, '5', 5.0 ); // $ExpectError - fcn2( 10, [], 5.0 ); // $ExpectError - fcn2( 10, {}, 5.0 ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0 ); // $ExpectError - - fcn2( 10, true, 5.0, {} ); // $ExpectError - fcn2( 10, false, 5.0, {} ); // $ExpectError - fcn2( 10, '5', 5.0, {} ); // $ExpectError - fcn2( 10, [], 5.0, {} ); // $ExpectError - fcn2( 10, {}, 5.0, {} ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0, {} ); // $ExpectError - - fcn2( 10, 2.0, true ); // $ExpectError - fcn2( 10, 2.0, false ); // $ExpectError - fcn2( 10, 2.0, '5' ); // $ExpectError - fcn2( 10, 2.0, [] ); // $ExpectError - fcn2( 10, 2.0, {} ); // $ExpectError - fcn2( 10, 2.0, ( x: number ): number => x ); // $ExpectError - - fcn2( 10, 2.0, true, {} ); // $ExpectError - fcn2( 10, 2.0, false, {} ); // $ExpectError - fcn2( 10, 2.0, '5', {} ); // $ExpectError - fcn2( 10, 2.0, [], {} ); // $ExpectError - fcn2( 10, 2.0, {}, {} ); // $ExpectError - fcn2( 10, 2.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 = uniform.factory(); - fcn1( 2.0, 5.0, { 'dtype': 123 } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': null } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError - - const fcn2 = uniform.factory( 2.0, 5.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 = uniform.factory( 2.0, 5.0 ); - fcn1(); // $ExpectError - fcn1( 1, 1, 1 ); // $ExpectError - - const fcn2 = uniform.factory(); - fcn2(); // $ExpectError - fcn2( 1 ); // $ExpectError - fcn2( 1, 1, 1, 1 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index c485546..0000000 --- a/examples/index.js +++ /dev/null @@ -1,48 +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'; - -var logEach = require( '@stdlib/console-log-each' ); -var uniform = require( './../lib' ); - -// Create a function for generating random arrays originating from the same state: -var random = uniform.factory( 2.0, 5.0, { - 'state': uniform.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 = uniform.factory( 2.0, 5.0, { - 'state': uniform.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 999d36d..cf23637 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 2.0 -/// +/// import { FloatDataType, 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..a4cb981 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-accessor@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-write-accessor@esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-constant-function@esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-noop@v0.0.14-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/random-base-uniform@esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-typed-real-float-ctors@esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-nullary@esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@esm/index.mjs";import f from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.0.2-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/array-typed-real-float-dtypes@esm/index.mjs";import h from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@esm/index.mjs";var u="float64",c=a();function y(e,t){return h(t)?j(t,"dtype")&&(e.dtype=t.dtype,c.indexOf(e.dtype)<0)?new TypeError(f("null3t","dtype",c.join('", "'),e.dtype)):null:new TypeError(f("null2h",t))}function g(){var a,h,j,c,g,b;if(j={dtype:u},0===(h=arguments.length))g=d,c=x;else if(1===h){if(a=arguments[0],g=d.factory(a),b=y(j,a))throw b;c=x}else if(2===h)g=d.factory(arguments[0],arguments[1]),c=v;else if(3===h){if(a=arguments[2],g=d.factory(arguments[0],arguments[1],a),b=y(j,a))throw b;c=v}return a&&a.prng?(e(c,"seed",null),e(c,"seedLength",null),s(c,"state",r(null),i),e(c,"stateLength",null),e(c,"byteLength",null)):(n(c,"seed",w),n(c,"seedLength",L),s(c,"state",P,R),n(c,"stateLength",G),n(c,"byteLength",N)),e(c,"PRNG",g.PRNG),c;function v(e,n){var s,r,i,d;if(!t(e))throw new TypeError(f("null2p",e));if(d={},arguments.length>1&&(r=y(d,n)))throw r;return"generic"===(i=d.dtype||j.dtype)?l(e,g):(s=new(o(i))(e),m([s],[e],[1],g),s)}function x(e,n,s,r){var i,d,m,a;if(!t(e))throw new TypeError(f("null2p",e));if(a={},arguments.length>3&&(d=y(a,r)))throw d;return"generic"===(m=a.dtype||j.dtype)?l(e,h):(i=new(o(m))(e),p([[n],[s],i],[e],[0,0,1],g),i);function h(){return g(n,s)}}function w(){return c.PRNG.seed}function L(){return c.PRNG.seedLength}function G(){return c.PRNG.stateLength}function N(){return c.PRNG.byteLength}function P(){return c.PRNG.state}function R(e){c.PRNG.state=e}}c.push("generic");var b=g();e(b,"factory",g);export{b as default,g as factory}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..4984bd1 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/factory.js","../lib/main.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 dtypes from '@stdlib/array-typed-real-float-dtypes';\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes();\nDTYPES.push( 'generic' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( 'null2h', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( DTYPES.indexOf( opts.dtype ) < 0 ) {\n\t\t\treturn new TypeError( format( 'null3t', 'dtype', DTYPES.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport setReadOnlyAccessor from '@stdlib/utils-define-nonenumerable-read-only-accessor';\nimport setReadWriteAccessor from '@stdlib/utils-define-nonenumerable-read-write-accessor';\nimport constantFunction from '@stdlib/utils-constant-function';\nimport noop from '@stdlib/utils-noop';\nimport base from '@stdlib/random-base-uniform';\nimport ctors from '@stdlib/array-typed-real-float-ctors';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport nullary from '@stdlib/strided-base-nullary';\nimport binary from '@stdlib/strided-base-binary';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution.\n*\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\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 {RangeError} `a` must be less than `b`\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 uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10 );\n* // returns \n*\n* @example\n* var uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nfunction factory() {\n\tvar options;\n\tvar nargs;\n\tvar opts;\n\tvar rand;\n\tvar prng;\n\tvar err;\n\n\topts = {\n\t\t'dtype': defaults.dtype\n\t};\n\n\tnargs = arguments.length;\n\tif ( nargs === 0 ) {\n\t\tprng = base;\n\t\trand = uniform2;\n\t} else if ( nargs === 1 ) {\n\t\toptions = arguments[ 0 ];\n\t\tprng = base.factory( options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform2;\n\t} else if ( nargs === 2 ) {\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ] );\n\t\trand = uniform1;\n\t} else if ( nargs === 3 ) {\n\t\toptions = arguments[ 2 ];\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ], options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform1;\n\t}\n\tif ( options && options.prng ) {\n\t\tsetReadOnly( rand, 'seed', null );\n\t\tsetReadOnly( rand, 'seedLength', null );\n\t\tsetReadWriteAccessor( rand, 'state', constantFunction( null ), noop );\n\t\tsetReadOnly( rand, 'stateLength', null );\n\t\tsetReadOnly( rand, 'byteLength', null );\n\t} else {\n\t\tsetReadOnlyAccessor( rand, 'seed', getSeed );\n\t\tsetReadOnlyAccessor( rand, 'seedLength', getSeedLength );\n\t\tsetReadWriteAccessor( rand, 'state', getState, setState );\n\t\tsetReadOnlyAccessor( rand, 'stateLength', getStateLength );\n\t\tsetReadOnlyAccessor( rand, 'byteLength', getStateSize );\n\t}\n\tsetReadOnly( rand, 'PRNG', prng.PRNG );\n\treturn rand;\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform1( len, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( 'null2p', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 1 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, prng );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tnullary( [ out ], [ len ], [ 1 ], prng );\n\t\treturn out;\n\t}\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {number} a - minimum support\n\t* @param {number} b - maximum support\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform2( len, a, b, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( 'null2p', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 3 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\t// NOTE: we could alternatively use the PRNG factory function to create a PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. Decision made here to avoid this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom number. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in a return value of `NaN`.\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, wrapper );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tbinary( [ [ a ], [ b ], out ], [ len ], [ 0, 0, 1 ], prng );\n\t\treturn out;\n\n\t\t/**\n\t\t* Applies parameters to a pseudorandom number generator function.\n\t\t*\n\t\t* @private\n\t\t* @returns {number} pseudorandom number\n\t\t*/\n\t\tfunction wrapper() {\n\t\t\treturn prng( a, b );\n\t\t}\n\t}\n\n\t/**\n\t* Returns the PRNG seed.\n\t*\n\t* @private\n\t* @returns {PRNGSeedMT19937} seed\n\t*/\n\tfunction getSeed() {\n\t\treturn rand.PRNG.seed;\n\t}\n\n\t/**\n\t* Returns the PRNG seed length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} seed length\n\t*/\n\tfunction getSeedLength() {\n\t\treturn rand.PRNG.seedLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state length\n\t*/\n\tfunction getStateLength() {\n\t\treturn rand.PRNG.stateLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state size (in bytes).\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state size (in bytes)\n\t*/\n\tfunction getStateSize() {\n\t\treturn rand.PRNG.byteLength;\n\t}\n\n\t/**\n\t* Returns the current pseudorandom number generator state.\n\t*\n\t* @private\n\t* @returns {PRNGStateMT19937} current state\n\t*/\n\tfunction getState() {\n\t\treturn rand.PRNG.state;\n\t}\n\n\t/**\n\t* Sets the pseudorandom number generator state.\n\t*\n\t* @private\n\t* @param {PRNGStateMT19937} s - generator state\n\t* @throws {Error} must provide a valid state\n\t*/\n\tfunction setState( s ) {\n\t\trand.PRNG.state = s;\n\t}\n}\n\n\n// EXPORTS //\n\nexport default factory;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @name uniform\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\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 = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar uniform = factory();\n\n\n// EXPORTS //\n\nexport default uniform;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @module @stdlib/random-array-uniform\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.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\" }\n"],"names":["DTYPES","dtypes","validate","opts","options","isObject","hasOwnProp","dtype","indexOf","TypeError","format","join","factory","nargs","rand","prng","err","defaults","arguments","length","base","uniform2","uniform1","setReadOnly","setReadWriteAccessor","constantFunction","noop","setReadOnlyAccessor","getSeed","getSeedLength","getState","setState","getStateLength","getStateSize","PRNG","len","out","dt","o","isNonNegativeInteger","filledBy","ctors","nullary","a","b","wrapper","binary","seed","seedLength","stateLength","byteLength","state","s","push","uniform","main"],"mappings":";;07CA8BIA,EAASC,IAyBb,SAASC,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,WACzBD,EAAKI,MAAQH,EAAQG,MAChBP,EAAOQ,QAASL,EAAKI,OAAU,GAC5B,IAAIE,UAAWC,EAAQ,SAAU,QAASV,EAAOW,KAAM,QAAUR,EAAKI,QAGxE,KARC,IAAIE,UAAWC,EAAQ,SAAUN,GAS1C,CCSA,SAASQ,IACR,IAAIR,EACAS,EACAV,EACAW,EACAC,EACAC,EAOJ,GALAb,EAAO,CACNI,MAASU,GAIK,KADfJ,EAAQK,UAAUC,QAEjBJ,EAAOK,EACPN,EAAOO,OACD,GAAe,IAAVR,EAAc,CAIzB,GAHAT,EAAUc,UAAW,GACrBH,EAAOK,EAAKR,QAASR,GACrBY,EAAMd,EAAUC,EAAMC,GAErB,MAAMY,EAEPF,EAAOO,CACT,MAAQ,GAAe,IAAVR,EACXE,EAAOK,EAAKR,QAASM,UAAW,GAAKA,UAAW,IAChDJ,EAAOQ,OACD,GAAe,IAAVT,EAAc,CAIzB,GAHAT,EAAUc,UAAW,GACrBH,EAAOK,EAAKR,QAASM,UAAW,GAAKA,UAAW,GAAKd,GACrDY,EAAMd,EAAUC,EAAMC,GAErB,MAAMY,EAEPF,EAAOQ,CACP,CAeD,OAdKlB,GAAWA,EAAQW,MACvBQ,EAAaT,EAAM,OAAQ,MAC3BS,EAAaT,EAAM,aAAc,MACjCU,EAAsBV,EAAM,QAASW,EAAkB,MAAQC,GAC/DH,EAAaT,EAAM,cAAe,MAClCS,EAAaT,EAAM,aAAc,QAEjCa,EAAqBb,EAAM,OAAQc,GACnCD,EAAqBb,EAAM,aAAce,GACzCL,EAAsBV,EAAM,QAASgB,EAAUC,GAC/CJ,EAAqBb,EAAM,cAAekB,GAC1CL,EAAqBb,EAAM,aAAcmB,IAE1CV,EAAaT,EAAM,OAAQC,EAAKmB,MACzBpB,EAcP,SAASQ,EAAUa,EAAK/B,GACvB,IACIgC,EACApB,EACAqB,EACAC,EACJ,IAAMC,EAAsBJ,GAC3B,MAAM,IAAI1B,UAAWC,EAAQ,SAAUyB,IAGxC,GADAG,EAAI,CAAA,EACCpB,UAAUC,OAAS,IACvBH,EAAMd,EAAUoC,EAAGlC,IAElB,MAAMY,EAIR,MAAY,aADZqB,EAAKC,EAAE/B,OAASJ,EAAKI,OAEbiC,EAAUL,EAAKpB,IAGvBqB,EAAM,IADCK,EAAOJ,GACR,CAAUF,GAChBO,EAAS,CAAEN,GAAO,CAAED,GAAO,CAAE,GAAKpB,GAC3BqB,EACP,CAgBD,SAASf,EAAUc,EAAKQ,EAAGC,EAAGxC,GAC7B,IACIgC,EACApB,EACAqB,EACAC,EACJ,IAAMC,EAAsBJ,GAC3B,MAAM,IAAI1B,UAAWC,EAAQ,SAAUyB,IAGxC,GADAG,EAAI,CAAA,EACCpB,UAAUC,OAAS,IACvBH,EAAMd,EAAUoC,EAAGlC,IAElB,MAAMY,EAKR,MAAY,aADZqB,EAAKC,EAAE/B,OAASJ,EAAKI,OAEbiC,EAAUL,EAAKU,IAGvBT,EAAM,IADCK,EAAOJ,GACR,CAAUF,GAChBW,EAAQ,CAAE,CAAEH,GAAK,CAAEC,GAAKR,GAAO,CAAED,GAAO,CAAE,EAAG,EAAG,GAAKpB,GAC9CqB,GAQP,SAASS,IACR,OAAO9B,EAAM4B,EAAGC,EAChB,CACD,CAQD,SAAShB,IACR,OAAOd,EAAKoB,KAAKa,IACjB,CAQD,SAASlB,IACR,OAAOf,EAAKoB,KAAKc,UACjB,CAQD,SAAShB,IACR,OAAOlB,EAAKoB,KAAKe,WACjB,CAQD,SAAShB,IACR,OAAOnB,EAAKoB,KAAKgB,UACjB,CAQD,SAASpB,IACR,OAAOhB,EAAKoB,KAAKiB,KACjB,CASD,SAASpB,EAAUqB,GAClBtC,EAAKoB,KAAKiB,MAAQC,CAClB,CACF,CDrPApD,EAAOqD,KAAM,WEqBV,IAACC,EAAU1C,ICiBdW,EAAAgC,EAAA,UAAA3C"} \ No newline at end of file diff --git a/lib/defaults.json b/lib/defaults.json deleted file mode 100644 index 83f4438..0000000 --- a/lib/defaults.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "dtype": "float64" -} diff --git a/lib/factory.js b/lib/factory.js deleted file mode 100644 index 9f232af..0000000 --- a/lib/factory.js +++ /dev/null @@ -1,282 +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 isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var setReadOnlyAccessor = require( '@stdlib/utils-define-nonenumerable-read-only-accessor' ); -var setReadWriteAccessor = require( '@stdlib/utils-define-nonenumerable-read-write-accessor' ); -var constantFunction = require( '@stdlib/utils-constant-function' ); -var noop = require( '@stdlib/utils-noop' ); -var base = require( '@stdlib/random-base-uniform' ); -var ctors = require( '@stdlib/array-typed-real-float-ctors' ); -var filledBy = require( '@stdlib/array-base-filled-by' ); -var nullary = require( '@stdlib/strided-base-nullary' ); -var binary = require( '@stdlib/strided-base-binary' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution. -* -* @param {number} [a] - minimum support -* @param {number} [b] - maximum support -* @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 {RangeError} `a` must be less than `b` -* @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 uniform = factory( 2.0, 5.0 ); -* // returns -* -* var arr = uniform( 10 ); -* // returns -* -* @example -* var uniform = factory( 2.0, 5.0 ); -* // returns -* -* var arr = uniform( 10, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -function factory() { - var options; - var nargs; - var opts; - var rand; - var prng; - var err; - - opts = { - 'dtype': defaults.dtype - }; - - nargs = arguments.length; - if ( nargs === 0 ) { - prng = base; - rand = uniform2; - } else if ( nargs === 1 ) { - options = arguments[ 0 ]; - prng = base.factory( options ); - err = validate( opts, options ); - if ( err ) { - throw err; - } - rand = uniform2; - } else if ( nargs === 2 ) { - prng = base.factory( arguments[ 0 ], arguments[ 1 ] ); - rand = uniform1; - } else if ( nargs === 3 ) { - options = arguments[ 2 ]; - prng = base.factory( arguments[ 0 ], arguments[ 1 ], options ); - err = validate( opts, options ); - if ( err ) { - throw err; - } - rand = uniform1; - } - if ( options && options.prng ) { - setReadOnly( rand, 'seed', null ); - setReadOnly( rand, 'seedLength', null ); - setReadWriteAccessor( rand, 'state', constantFunction( null ), noop ); - setReadOnly( rand, 'stateLength', null ); - setReadOnly( rand, 'byteLength', null ); - } else { - setReadOnlyAccessor( rand, 'seed', getSeed ); - setReadOnlyAccessor( rand, 'seedLength', getSeedLength ); - setReadWriteAccessor( rand, 'state', getState, setState ); - setReadOnlyAccessor( rand, 'stateLength', getStateLength ); - setReadOnlyAccessor( rand, 'byteLength', getStateSize ); - } - setReadOnly( rand, 'PRNG', prng.PRNG ); - return rand; - - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @private - * @param {NonNegativeInteger} len - array length - * @param {Options} [options] - function options - * @param {string} [options.dtype] - 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 - */ - function uniform1( len, options ) { - var ctor; - var out; - var err; - var dt; - var o; - if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( 'null2p', len ) ); - } - o = {}; - if ( arguments.length > 1 ) { - err = validate( o, options ); - if ( err ) { - throw err; - } - } - dt = o.dtype || opts.dtype; - if ( dt === 'generic' ) { - return filledBy( len, prng ); - } - ctor = ctors( dt ); - out = new ctor( len ); - nullary( [ out ], [ len ], [ 1 ], prng ); - return out; - } - - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @private - * @param {NonNegativeInteger} len - array length - * @param {number} a - minimum support - * @param {number} b - maximum support - * @param {Options} [options] - function options - * @param {string} [options.dtype] - 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 - */ - function uniform2( len, a, b, options ) { - var ctor; - var out; - var err; - var dt; - var o; - if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( 'null2p', len ) ); - } - o = {}; - if ( arguments.length > 3 ) { - err = validate( o, options ); - if ( err ) { - throw err; - } - } - // NOTE: we could alternatively use the PRNG factory function to create a PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. Decision made here to avoid this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom number. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in a return value of `NaN`. - dt = o.dtype || opts.dtype; - if ( dt === 'generic' ) { - return filledBy( len, wrapper ); - } - ctor = ctors( dt ); - out = new ctor( len ); - binary( [ [ a ], [ b ], out ], [ len ], [ 0, 0, 1 ], prng ); - return out; - - /** - * Applies parameters to a pseudorandom number generator function. - * - * @private - * @returns {number} pseudorandom number - */ - function wrapper() { - return prng( a, b ); - } - } - - /** - * Returns the PRNG seed. - * - * @private - * @returns {PRNGSeedMT19937} seed - */ - function getSeed() { - return rand.PRNG.seed; - } - - /** - * Returns the PRNG seed length. - * - * @private - * @returns {PositiveInteger} seed length - */ - function getSeedLength() { - return rand.PRNG.seedLength; - } - - /** - * Returns the PRNG state length. - * - * @private - * @returns {PositiveInteger} state length - */ - function getStateLength() { - return rand.PRNG.stateLength; - } - - /** - * Returns the PRNG state size (in bytes). - * - * @private - * @returns {PositiveInteger} state size (in bytes) - */ - function getStateSize() { - return rand.PRNG.byteLength; - } - - /** - * Returns the current pseudorandom number generator state. - * - * @private - * @returns {PRNGStateMT19937} current state - */ - function getState() { - return rand.PRNG.state; - } - - /** - * Sets the pseudorandom number generator state. - * - * @private - * @param {PRNGStateMT19937} s - generator state - * @throws {Error} must provide a valid state - */ - function setState( s ) { - rand.PRNG.state = s; - } -} - - -// EXPORTS // - -module.exports = factory; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 0077f00..0000000 --- a/lib/index.js +++ /dev/null @@ -1,77 +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'; - -/** -* Create an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. -* -* @module @stdlib/random-array-uniform -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var arr = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var arr = uniform( 10, 2.0, 5.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var rand = uniform.factory( 2.0, 5.0 ); -* // returns -* -* var arr = rand( 10 ); -* // returns -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var rand = uniform.factory( 2.0, 5.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" } diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index da0d9b1..0000000 --- a/lib/main.js +++ /dev/null @@ -1,58 +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 factory = require( './factory.js' ); - - -// MAIN // - -/** -* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. -* -* @name uniform -* @type {Function} -* @param {NonNegativeInteger} len - array length -* @param {number} a - minimum support -* @param {number} b - maximum support -* @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 = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var arr = uniform( 10, 2.0, 5.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -var uniform = factory(); - - -// EXPORTS // - -module.exports = uniform; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index 3629aaf..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,72 +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 dtypes = require( '@stdlib/array-typed-real-float-dtypes' ); -var isObject = require( '@stdlib/assert-is-plain-object' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// VARIABLES // - -var DTYPES = dtypes(); -DTYPES.push( 'generic' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Options} options - function options -* @param {string} [options.dtype] - output array data type -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var options = { -* 'dtype': 'float64' -* }; -* var err = validate( opts, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( 'null2h', options ) ); - } - if ( hasOwnProp( options, 'dtype' ) ) { - opts.dtype = options.dtype; - if ( DTYPES.indexOf( opts.dtype ) < 0 ) { - return new TypeError( format( 'null3t', 'dtype', DTYPES.join( '", "' ), opts.dtype ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index 8b6d28d..621da6a 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 continuous uniform 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,55 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-filled-by": "^0.0.2", - "@stdlib/array-typed-real-float-ctors": "^0.0.1", - "@stdlib/array-typed-real-float-dtypes": "^0.0.1", - "@stdlib/assert-has-own-property": "^0.0.7", - "@stdlib/assert-is-nonnegative-integer": "^0.0.7", - "@stdlib/assert-is-plain-object": "^0.0.7", - "@stdlib/random-base-uniform": "^0.0.6", - "@stdlib/strided-base-binary": "^0.0.8", - "@stdlib/strided-base-nullary": "^0.0.7", - "@stdlib/error-tools-fmtprodmsg": "^0.0.2", - "@stdlib/types": "^0.0.14", - "@stdlib/utils-constant-function": "^0.0.8", - "@stdlib/utils-define-nonenumerable-read-only-accessor": "^0.0.7", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.7", - "@stdlib/utils-define-nonenumerable-read-write-accessor": "^0.0.7", - "@stdlib/utils-noop": "^0.0.14" - }, - "devDependencies": { - "@stdlib/array-float32": "^0.0.6", - "@stdlib/array-float64": "^0.0.6", - "@stdlib/array-uint32": "^0.0.6", - "@stdlib/assert-is-uint32array": "^0.0.8", - "@stdlib/bench": "^0.0.12", - "@stdlib/console-log-each": "^0.0.2", - "@stdlib/constants-uint32-max": "^0.0.7", - "@stdlib/math-base-assert-is-nan": "^0.0.8", - "@stdlib/math-base-assert-is-nanf": "^0.0.8", - "@stdlib/math-base-special-pow": "^0.0.7", - "@stdlib/random-base-minstd": "^0.0.6", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdmath", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..7f88cdc --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/test.factory.js b/test/test.factory.js deleted file mode 100644 index a869e75..0000000 --- a/test/test.factory.js +++ /dev/null @@ -1,1328 +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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -tape( 'the function throws an error if the second distribution parameter is less than the first distribution parameter', function test( t ) { - var values; - var i; - - values = [ - [ 0.0, 0.0 ], - [ -2.0, -4.0 ], - [ 2.0, 1.0 ] - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( arr ) { - return function badValue() { - factory( arr[0], arr[1] ); - }; - } -}); - -tape( 'the function throws an error if the second distribution parameter is less than the first distribution parameter (options)', function test( t ) { - var values; - var i; - - values = [ - [ 0.0, 0.0 ], - [ -2.0, -4.0 ], - [ 2.0, 1.0 ] - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( arr ) { - return function badValue() { - factory( arr[0], arr[1], {} ); - }; - } -}); - -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, 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, { - '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, { - '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, { - '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, { - '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, { - '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, { - '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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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 ); - - 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 ); - - 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, { - '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 ); - - 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 ); - 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( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory(); - actual = random( 10, 2.0, 5.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( typeof actual[ i ], 'number', '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 ); - - 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 ); - - 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 ); - - 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 that generates `NaN` values if the first distribution parameter is greater than or equal to the second distribution parameter', function test( t ) { - var random; - var values; - var actual; - var i; - var j; - - random = factory(); - values = [ - [ 2.0, 1.0 ], - [ -3.0, -4.0 ], - [ 0.0, 0.0 ] - ]; - - for ( i = 0; i < values.length; i++ ) { - actual = random( 10, values[ i ][ 0 ], values[ i ][ 1 ] ); - for ( j = 0; j < actual.length; j++ ) { - t.strictEqual( isnan( actual[ j ] ), true, 'returns expected value when provided '+values[ 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, { - '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 ); - - 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, { - '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( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'float64' - }); - actual = random( 10, 2.0, 5.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( typeof actual[ i ], 'number', '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, { - '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( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'float32' - }); - actual = random( 10, 2.0, 5.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( typeof actual[ i ], 'number', '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, { - '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 ); - - 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, { - '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, { - '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 ); - - // 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, { - '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 ); - - // 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, { - '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 ); - - 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, { - 'prng': randu.normalized - }); - - randu = minstd.factory({ - 'seed': seed - }); - random2 = factory( 2.0, 5.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 ); - arr2 = random2( 10, 2.0, 5.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 c4fb6d3..0000000 --- a/test/test.js +++ /dev/null @@ -1,69 +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 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 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 37b0080..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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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, 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, { - '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 ); - - 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( typeof actual[ i ], 'number', '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, { - '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( typeof actual[ i ], 'number', '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, { - '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( typeof actual[ i ], 'number', '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, { - '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 ); - } - // Capture the current state: - state = random.state; - - // Move to a future state... - arr = random( 10, 2.0, 5.0 ); - for ( i = 0; i < 100; i++ ) { - random( 2, 2.0, 5.0 ); - } - // Set the state: - random.state = state; - - // Replay previously generated values: - t.deepEqual( random( 10, 2.0, 5.0 ), arr, 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.validate.js b/test/test.validate.js deleted file mode 100644 index c515526..0000000 --- a/test/test.validate.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 validate = require( './../lib/validate.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.equal( typeof validate, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function returns an error if provided an options argument which is not an object', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - void 0, - null, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, values[ i ] ); - t.equal( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided a `dtype` option which is not a supported data type', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - -5, - NaN, - true, - false, - void 0, - null, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, { - 'dtype': values[ i ] - }); - t.equal( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns null if all options are valid', function test( t ) { - var options; - var opts; - var err; - - options = { - 'dtype': 'float64' - }; - opts = {}; - err = validate( opts, options ); - - t.equal( err, null, 'returns null' ); - t.deepEqual( opts, options, 'sets option values' ); - - t.end(); -}); - -tape( 'the function ignores unrecognized/unsupported options', function test( t ) { - var options; - var opts; - var err; - - options = { - 'beep': true, - 'boop': 'bop' - }; - opts = {}; - err = validate( opts, options ); - - t.equal( err, null, 'returns null' ); - t.deepEqual( opts, {}, 'does not set any option values' ); - t.end(); -}); From 598cb7c708234e10a329ee4bc124ce38bdaa7c04 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 10 Feb 2023 01:14:14 +0000 Subject: [PATCH 06/82] Transform error messages --- lib/factory.js | 6 +++--- lib/validate.js | 6 +++--- package.json | 2 +- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/lib/factory.js b/lib/factory.js index 22ec236..9f232af 100644 --- a/lib/factory.js +++ b/lib/factory.js @@ -31,7 +31,7 @@ var ctors = require( '@stdlib/array-typed-real-float-ctors' ); var filledBy = require( '@stdlib/array-base-filled-by' ); var nullary = require( '@stdlib/strided-base-nullary' ); var binary = require( '@stdlib/strided-base-binary' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -144,7 +144,7 @@ function factory() { var dt; var o; if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) ); + throw new TypeError( format( 'null2p', len ) ); } o = {}; if ( arguments.length > 1 ) { @@ -184,7 +184,7 @@ function factory() { var dt; var o; if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) ); + throw new TypeError( format( 'null2p', len ) ); } o = {}; if ( arguments.length > 3 ) { diff --git a/lib/validate.js b/lib/validate.js index 40b9723..3629aaf 100644 --- a/lib/validate.js +++ b/lib/validate.js @@ -23,7 +23,7 @@ var dtypes = require( '@stdlib/array-typed-real-float-dtypes' ); var isObject = require( '@stdlib/assert-is-plain-object' ); var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // VARIABLES // @@ -55,12 +55,12 @@ DTYPES.push( 'generic' ); */ function validate( opts, options ) { if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); + return new TypeError( format( 'null2h', options ) ); } if ( hasOwnProp( options, 'dtype' ) ) { opts.dtype = options.dtype; if ( DTYPES.indexOf( opts.dtype ) < 0 ) { - return new TypeError( format( 'invalid option. `%s` option must be one of the following: "%s". Option: `%s`.', 'dtype', DTYPES.join( '", "' ), opts.dtype ) ); + return new TypeError( format( 'null3t', 'dtype', DTYPES.join( '", "' ), opts.dtype ) ); } } return null; diff --git a/package.json b/package.json index 486f4d2..8b6d28d 100644 --- a/package.json +++ b/package.json @@ -46,7 +46,7 @@ "@stdlib/random-base-uniform": "^0.0.6", "@stdlib/strided-base-binary": "^0.0.8", "@stdlib/strided-base-nullary": "^0.0.7", - "@stdlib/string-format": "^0.0.3", + "@stdlib/error-tools-fmtprodmsg": "^0.0.2", "@stdlib/types": "^0.0.14", "@stdlib/utils-constant-function": "^0.0.8", "@stdlib/utils-define-nonenumerable-read-only-accessor": "^0.0.7", From 7b4794b91fc2738113b5b43d521fb434b0cc7095 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 10 Feb 2023 01:16:25 +0000 Subject: [PATCH 07/82] Remove files --- index.d.ts | 245 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6427 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 cf23637..0000000 --- a/index.d.ts +++ /dev/null @@ -1,245 +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. -*/ - -// TypeScript Version: 2.0 - -/// - -import { FloatDataType, FloatTypedArray } from '@stdlib/types/array'; -import * as random from '@stdlib/types/random'; - -/** -* Supported data types. -*/ -type DataType = FloatDataType | 'generic'; - -/** -* 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 { - /** - * Default output array data type. Default: 'float64'. - */ - 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 uniformly distributed pseudorandom numbers with pre-specified parameter values. -*/ -interface UnaryFunction extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @param len - array length - * @param options - function options - * @returns output array - */ - ( len: number, options?: Options ): RandomArray; -} - -/** -* Interface for generating uniformly distributed pseudorandom numbers without pre-specified parameter values. -*/ -interface TernaryFunction extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @param len - array length - * @param a - minimum support - * @param b - maximum support - * @param options - function options - * @returns output array - */ - ( len: number, a: number, b: number, options?: Options ): RandomArray; -} - -/** -* Interface for generating pseudorandom numbers drawn from a uniform distribution. -*/ -interface Random extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @param len - array length - * @param a - minimum support - * @param b - maximum support - * @param options - function options - * @returns output array - * - * @example - * var out = uniform( 10, 2.0, 5.0 ); - * // returns - */ - ( len: number, a: number, b: number, options?: Options ): RandomArray; - - /** - * Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution. - * - * ## Notes - * - * - When provided `a` and `b`, the returned function returns random variates drawn from the specified distribution. - * - * @param a - minimum support - * @param b - maximum support - * @param options - function options - * @throws `a` must be less than `b` - * @throws must provide a valid state - * @returns function for creating arrays - * - * @example - * var random = uniform.factory( 2.0, 5.0 ); - * - * var out = random( 10 ); - * // returns - * - * @example - * var random = uniform.factory( 2.0, 5.0, { - * 'seed': 297 - * }); - * var out = random( 10 ); - * // returns - */ - factory( a: number, b: number, options?: FactoryOptions ): UnaryFunction; - - /** - * Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution. - * - * ## Notes - * - * - When not provided `a` and `b`, the returned function requires that both `a` and `b` be provided at each invocation. - * - * @param options - function options - * @throws must provide a valid state - * @returns function for creating arrays - * - * @example - * var random = uniform.factory(); - * - * var out = random( 10, 2.0, 5.0 ); - * // returns - * - * @example - * var random = uniform.factory({ - * 'seed': 297 - * }); - * var out = random( 10, 2.0, 5.0 ); - * // returns - */ - factory( options?: FactoryOptions ): TernaryFunction; -} - -/** -* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. -* -* @param len - array length -* @param a - minimum support -* @param b - maximum support -* @param options - function options -* @returns output array -* -* @example -* var out = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var random = uniform.factory( 2.0, 5.0 ); -* -* var out = random( 10 ); -* // returns -*/ -declare var uniform: Random; - - -// EXPORTS // - -export = uniform; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index a4cb981..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-accessor@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-write-accessor@esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-constant-function@esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-noop@v0.0.14-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/random-base-uniform@esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-typed-real-float-ctors@esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-nullary@esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@esm/index.mjs";import f from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.0.2-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/array-typed-real-float-dtypes@esm/index.mjs";import h from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@esm/index.mjs";var u="float64",c=a();function y(e,t){return h(t)?j(t,"dtype")&&(e.dtype=t.dtype,c.indexOf(e.dtype)<0)?new TypeError(f("null3t","dtype",c.join('", "'),e.dtype)):null:new TypeError(f("null2h",t))}function g(){var a,h,j,c,g,b;if(j={dtype:u},0===(h=arguments.length))g=d,c=x;else if(1===h){if(a=arguments[0],g=d.factory(a),b=y(j,a))throw b;c=x}else if(2===h)g=d.factory(arguments[0],arguments[1]),c=v;else if(3===h){if(a=arguments[2],g=d.factory(arguments[0],arguments[1],a),b=y(j,a))throw b;c=v}return a&&a.prng?(e(c,"seed",null),e(c,"seedLength",null),s(c,"state",r(null),i),e(c,"stateLength",null),e(c,"byteLength",null)):(n(c,"seed",w),n(c,"seedLength",L),s(c,"state",P,R),n(c,"stateLength",G),n(c,"byteLength",N)),e(c,"PRNG",g.PRNG),c;function v(e,n){var s,r,i,d;if(!t(e))throw new TypeError(f("null2p",e));if(d={},arguments.length>1&&(r=y(d,n)))throw r;return"generic"===(i=d.dtype||j.dtype)?l(e,g):(s=new(o(i))(e),m([s],[e],[1],g),s)}function x(e,n,s,r){var i,d,m,a;if(!t(e))throw new TypeError(f("null2p",e));if(a={},arguments.length>3&&(d=y(a,r)))throw d;return"generic"===(m=a.dtype||j.dtype)?l(e,h):(i=new(o(m))(e),p([[n],[s],i],[e],[0,0,1],g),i);function h(){return g(n,s)}}function w(){return c.PRNG.seed}function L(){return c.PRNG.seedLength}function G(){return c.PRNG.stateLength}function N(){return c.PRNG.byteLength}function P(){return c.PRNG.state}function R(e){c.PRNG.state=e}}c.push("generic");var b=g();e(b,"factory",g);export{b as default,g as factory}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 4984bd1..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/factory.js","../lib/main.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 dtypes from '@stdlib/array-typed-real-float-dtypes';\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes();\nDTYPES.push( 'generic' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( 'null2h', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( DTYPES.indexOf( opts.dtype ) < 0 ) {\n\t\t\treturn new TypeError( format( 'null3t', 'dtype', DTYPES.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport setReadOnlyAccessor from '@stdlib/utils-define-nonenumerable-read-only-accessor';\nimport setReadWriteAccessor from '@stdlib/utils-define-nonenumerable-read-write-accessor';\nimport constantFunction from '@stdlib/utils-constant-function';\nimport noop from '@stdlib/utils-noop';\nimport base from '@stdlib/random-base-uniform';\nimport ctors from '@stdlib/array-typed-real-float-ctors';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport nullary from '@stdlib/strided-base-nullary';\nimport binary from '@stdlib/strided-base-binary';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution.\n*\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\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 {RangeError} `a` must be less than `b`\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 uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10 );\n* // returns \n*\n* @example\n* var uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nfunction factory() {\n\tvar options;\n\tvar nargs;\n\tvar opts;\n\tvar rand;\n\tvar prng;\n\tvar err;\n\n\topts = {\n\t\t'dtype': defaults.dtype\n\t};\n\n\tnargs = arguments.length;\n\tif ( nargs === 0 ) {\n\t\tprng = base;\n\t\trand = uniform2;\n\t} else if ( nargs === 1 ) {\n\t\toptions = arguments[ 0 ];\n\t\tprng = base.factory( options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform2;\n\t} else if ( nargs === 2 ) {\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ] );\n\t\trand = uniform1;\n\t} else if ( nargs === 3 ) {\n\t\toptions = arguments[ 2 ];\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ], options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform1;\n\t}\n\tif ( options && options.prng ) {\n\t\tsetReadOnly( rand, 'seed', null );\n\t\tsetReadOnly( rand, 'seedLength', null );\n\t\tsetReadWriteAccessor( rand, 'state', constantFunction( null ), noop );\n\t\tsetReadOnly( rand, 'stateLength', null );\n\t\tsetReadOnly( rand, 'byteLength', null );\n\t} else {\n\t\tsetReadOnlyAccessor( rand, 'seed', getSeed );\n\t\tsetReadOnlyAccessor( rand, 'seedLength', getSeedLength );\n\t\tsetReadWriteAccessor( rand, 'state', getState, setState );\n\t\tsetReadOnlyAccessor( rand, 'stateLength', getStateLength );\n\t\tsetReadOnlyAccessor( rand, 'byteLength', getStateSize );\n\t}\n\tsetReadOnly( rand, 'PRNG', prng.PRNG );\n\treturn rand;\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform1( len, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( 'null2p', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 1 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, prng );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tnullary( [ out ], [ len ], [ 1 ], prng );\n\t\treturn out;\n\t}\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {number} a - minimum support\n\t* @param {number} b - maximum support\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform2( len, a, b, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( 'null2p', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 3 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\t// NOTE: we could alternatively use the PRNG factory function to create a PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. Decision made here to avoid this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom number. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in a return value of `NaN`.\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, wrapper );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tbinary( [ [ a ], [ b ], out ], [ len ], [ 0, 0, 1 ], prng );\n\t\treturn out;\n\n\t\t/**\n\t\t* Applies parameters to a pseudorandom number generator function.\n\t\t*\n\t\t* @private\n\t\t* @returns {number} pseudorandom number\n\t\t*/\n\t\tfunction wrapper() {\n\t\t\treturn prng( a, b );\n\t\t}\n\t}\n\n\t/**\n\t* Returns the PRNG seed.\n\t*\n\t* @private\n\t* @returns {PRNGSeedMT19937} seed\n\t*/\n\tfunction getSeed() {\n\t\treturn rand.PRNG.seed;\n\t}\n\n\t/**\n\t* Returns the PRNG seed length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} seed length\n\t*/\n\tfunction getSeedLength() {\n\t\treturn rand.PRNG.seedLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state length\n\t*/\n\tfunction getStateLength() {\n\t\treturn rand.PRNG.stateLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state size (in bytes).\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state size (in bytes)\n\t*/\n\tfunction getStateSize() {\n\t\treturn rand.PRNG.byteLength;\n\t}\n\n\t/**\n\t* Returns the current pseudorandom number generator state.\n\t*\n\t* @private\n\t* @returns {PRNGStateMT19937} current state\n\t*/\n\tfunction getState() {\n\t\treturn rand.PRNG.state;\n\t}\n\n\t/**\n\t* Sets the pseudorandom number generator state.\n\t*\n\t* @private\n\t* @param {PRNGStateMT19937} s - generator state\n\t* @throws {Error} must provide a valid state\n\t*/\n\tfunction setState( s ) {\n\t\trand.PRNG.state = s;\n\t}\n}\n\n\n// EXPORTS //\n\nexport default factory;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @name uniform\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\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 = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar uniform = factory();\n\n\n// EXPORTS //\n\nexport default uniform;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @module @stdlib/random-array-uniform\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.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\" }\n"],"names":["DTYPES","dtypes","validate","opts","options","isObject","hasOwnProp","dtype","indexOf","TypeError","format","join","factory","nargs","rand","prng","err","defaults","arguments","length","base","uniform2","uniform1","setReadOnly","setReadWriteAccessor","constantFunction","noop","setReadOnlyAccessor","getSeed","getSeedLength","getState","setState","getStateLength","getStateSize","PRNG","len","out","dt","o","isNonNegativeInteger","filledBy","ctors","nullary","a","b","wrapper","binary","seed","seedLength","stateLength","byteLength","state","s","push","uniform","main"],"mappings":";;07CA8BIA,EAASC,IAyBb,SAASC,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,WACzBD,EAAKI,MAAQH,EAAQG,MAChBP,EAAOQ,QAASL,EAAKI,OAAU,GAC5B,IAAIE,UAAWC,EAAQ,SAAU,QAASV,EAAOW,KAAM,QAAUR,EAAKI,QAGxE,KARC,IAAIE,UAAWC,EAAQ,SAAUN,GAS1C,CCSA,SAASQ,IACR,IAAIR,EACAS,EACAV,EACAW,EACAC,EACAC,EAOJ,GALAb,EAAO,CACNI,MAASU,GAIK,KADfJ,EAAQK,UAAUC,QAEjBJ,EAAOK,EACPN,EAAOO,OACD,GAAe,IAAVR,EAAc,CAIzB,GAHAT,EAAUc,UAAW,GACrBH,EAAOK,EAAKR,QAASR,GACrBY,EAAMd,EAAUC,EAAMC,GAErB,MAAMY,EAEPF,EAAOO,CACT,MAAQ,GAAe,IAAVR,EACXE,EAAOK,EAAKR,QAASM,UAAW,GAAKA,UAAW,IAChDJ,EAAOQ,OACD,GAAe,IAAVT,EAAc,CAIzB,GAHAT,EAAUc,UAAW,GACrBH,EAAOK,EAAKR,QAASM,UAAW,GAAKA,UAAW,GAAKd,GACrDY,EAAMd,EAAUC,EAAMC,GAErB,MAAMY,EAEPF,EAAOQ,CACP,CAeD,OAdKlB,GAAWA,EAAQW,MACvBQ,EAAaT,EAAM,OAAQ,MAC3BS,EAAaT,EAAM,aAAc,MACjCU,EAAsBV,EAAM,QAASW,EAAkB,MAAQC,GAC/DH,EAAaT,EAAM,cAAe,MAClCS,EAAaT,EAAM,aAAc,QAEjCa,EAAqBb,EAAM,OAAQc,GACnCD,EAAqBb,EAAM,aAAce,GACzCL,EAAsBV,EAAM,QAASgB,EAAUC,GAC/CJ,EAAqBb,EAAM,cAAekB,GAC1CL,EAAqBb,EAAM,aAAcmB,IAE1CV,EAAaT,EAAM,OAAQC,EAAKmB,MACzBpB,EAcP,SAASQ,EAAUa,EAAK/B,GACvB,IACIgC,EACApB,EACAqB,EACAC,EACJ,IAAMC,EAAsBJ,GAC3B,MAAM,IAAI1B,UAAWC,EAAQ,SAAUyB,IAGxC,GADAG,EAAI,CAAA,EACCpB,UAAUC,OAAS,IACvBH,EAAMd,EAAUoC,EAAGlC,IAElB,MAAMY,EAIR,MAAY,aADZqB,EAAKC,EAAE/B,OAASJ,EAAKI,OAEbiC,EAAUL,EAAKpB,IAGvBqB,EAAM,IADCK,EAAOJ,GACR,CAAUF,GAChBO,EAAS,CAAEN,GAAO,CAAED,GAAO,CAAE,GAAKpB,GAC3BqB,EACP,CAgBD,SAASf,EAAUc,EAAKQ,EAAGC,EAAGxC,GAC7B,IACIgC,EACApB,EACAqB,EACAC,EACJ,IAAMC,EAAsBJ,GAC3B,MAAM,IAAI1B,UAAWC,EAAQ,SAAUyB,IAGxC,GADAG,EAAI,CAAA,EACCpB,UAAUC,OAAS,IACvBH,EAAMd,EAAUoC,EAAGlC,IAElB,MAAMY,EAKR,MAAY,aADZqB,EAAKC,EAAE/B,OAASJ,EAAKI,OAEbiC,EAAUL,EAAKU,IAGvBT,EAAM,IADCK,EAAOJ,GACR,CAAUF,GAChBW,EAAQ,CAAE,CAAEH,GAAK,CAAEC,GAAKR,GAAO,CAAED,GAAO,CAAE,EAAG,EAAG,GAAKpB,GAC9CqB,GAQP,SAASS,IACR,OAAO9B,EAAM4B,EAAGC,EAChB,CACD,CAQD,SAAShB,IACR,OAAOd,EAAKoB,KAAKa,IACjB,CAQD,SAASlB,IACR,OAAOf,EAAKoB,KAAKc,UACjB,CAQD,SAAShB,IACR,OAAOlB,EAAKoB,KAAKe,WACjB,CAQD,SAAShB,IACR,OAAOnB,EAAKoB,KAAKgB,UACjB,CAQD,SAASpB,IACR,OAAOhB,EAAKoB,KAAKiB,KACjB,CASD,SAASpB,EAAUqB,GAClBtC,EAAKoB,KAAKiB,MAAQC,CAClB,CACF,CDrPApD,EAAOqD,KAAM,WEqBV,IAACC,EAAU1C,ICiBdW,EAAAgC,EAAA,UAAA3C"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 7f88cdc..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 1826e7b502a5dfee660447ff013a245ddf3f3d6a Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 10 Feb 2023 01:17:17 +0000 Subject: [PATCH 08/82] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 62 - .github/workflows/cancel.yml | 56 - .github/workflows/close_pull_requests.yml | 44 - .github/workflows/examples.yml | 62 - .github/workflows/npm_downloads.yml | 108 - .github/workflows/productionize.yml | 798 --- .github/workflows/publish.yml | 236 - .github/workflows/test.yml | 97 - .github/workflows/test_bundles.yml | 180 - .github/workflows/test_coverage.yml | 123 - .github/workflows/test_install.yml | 83 - .gitignore | 184 - .npmignore | 227 - .npmrc | 28 - CHANGELOG.md | 5 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 61 +- benchmark/benchmark.float32.factory.js | 96 - benchmark/benchmark.float32.js | 98 - benchmark/benchmark.float64.factory.js | 96 - benchmark/benchmark.float64.js | 98 - benchmark/benchmark.generic.factory.js | 96 - benchmark/benchmark.generic.js | 98 - branches.md | 53 - docs/repl.txt | 192 - docs/types/test.ts | 355 -- examples/index.js | 48 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/defaults.json | 3 - lib/factory.js | 282 - lib/index.js | 77 - lib/main.js | 58 - lib/validate.js | 72 - package.json | 76 +- stats.html | 6177 +++++++++++++++++++++ test/test.factory.js | 1328 ----- test/test.js | 69 - test/test.main.js | 244 - test/test.validate.js | 118 - 47 files changed, 6215 insertions(+), 6658 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 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 benchmark/benchmark.float32.factory.js delete mode 100644 benchmark/benchmark.float32.js delete mode 100644 benchmark/benchmark.float64.factory.js delete mode 100644 benchmark/benchmark.float64.js delete mode 100644 benchmark/benchmark.generic.factory.js delete mode 100644 benchmark/benchmark.generic.js delete mode 100644 branches.md 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/defaults.json delete mode 100644 lib/factory.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/test.factory.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js delete mode 100644 test/test.validate.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 0fd4d6c..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 `tslint.json` files: -[tslint.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 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 c4ab52b..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/uniform) 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 06a9a75..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,62 +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' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 a00dbe5..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,56 +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' - uses: styfle/cancel-workflow-action@0.11.0 - 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 7eca213..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,44 +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: - run: - runs-on: ubuntu-latest - steps: - - uses: superbrothers/close-pull-request@v3 - 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/uniform) 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 7902a7d..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,62 +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 the repository: - - name: 'Checkout the repository' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 818b9df..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,108 +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: '33 9 * * 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' - uses: actions/checkout@v3 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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' - uses: actions/upload-artifact@v3 - 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' - uses: distributhor/workflow-webhook@v3 - 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 3e8e2db..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,798 +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' - uses: actions/checkout@v3 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 - - # Format error messages: - - name: 'Replace double quotes with single quotes in rewritten format string error messages' - run: | - find . -name "*.js" -exec sed -E -i "s/Error\( format\( \"([a-zA-Z0-9]+)\"/Error\( format\( '\1'/g" {} \; - - # Format string literal error messages: - - name: 'Replace double quotes with single quotes in rewritten string literal error messages' - run: | - find . -name "*.js" -exec sed -E -i "s/Error\( format\(\"([a-zA-Z0-9]+)\"\)/Error\( format\( '\1' \)/g" {} \; - - # Format code: - - name: 'Replace double quotes with single quotes in inserted `require` calls' - run: | - find . -name "*.js" -exec sed -E -i "s/require\( ?\"@stdlib\/error-tools-fmtprodmsg\" ?\);/require\( '@stdlib\/error-tools-fmtprodmsg' \);/g" {} \; - - # 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' }} - uses: actions/checkout@v3 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - uses: actions/setup-node@v3 - with: - node-version: 16 - 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' - uses: actions/checkout@v3 - - # 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' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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' - uses: act10ns/slack@v1 - 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' - uses: actions/checkout@v3 - - # 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' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 + + ```
@@ -364,7 +363,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]. @@ -424,13 +423,13 @@ Copyright © 2016-2023. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/random-array-uniform/main/LICENSE -[@stdlib/random/base/uniform]: https://github.com/stdlib-js/random-base-uniform +[@stdlib/random/base/uniform]: https://github.com/stdlib-js/random-base-uniform/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/benchmark/benchmark.float32.factory.js b/benchmark/benchmark.float32.factory.js deleted file mode 100644 index 67e61f4..0000000 --- a/benchmark/benchmark.float32.factory.js +++ /dev/null @@ -1,96 +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 bench = require( '@stdlib/bench' ); -var isnanf = require( '@stdlib/math-base-assert-is-nanf' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var fcn = uniform.factory( 2.0, 5.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 4642816..0000000 --- a/benchmark/benchmark.float32.js +++ /dev/null @@ -1,98 +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 bench = require( '@stdlib/bench' ); -var isnanf = require( '@stdlib/math-base-assert-is-nanf' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = 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 = uniform( len, 2.0, 5.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.factory.js b/benchmark/benchmark.float64.factory.js deleted file mode 100644 index 8646a54..0000000 --- a/benchmark/benchmark.float64.factory.js +++ /dev/null @@ -1,96 +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 bench = require( '@stdlib/bench' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var fcn = uniform.factory( 2.0, 5.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 5ee0d97..0000000 --- a/benchmark/benchmark.float64.js +++ /dev/null @@ -1,98 +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 bench = require( '@stdlib/bench' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = 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 = uniform( len, 2.0, 5.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.factory.js b/benchmark/benchmark.generic.factory.js deleted file mode 100644 index 7020d62..0000000 --- a/benchmark/benchmark.generic.factory.js +++ /dev/null @@ -1,96 +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 bench = require( '@stdlib/bench' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var fcn = uniform.factory( 2.0, 5.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 06a2a83..0000000 --- a/benchmark/benchmark.generic.js +++ /dev/null @@ -1,98 +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 bench = require( '@stdlib/bench' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = 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 = uniform( len, 2.0, 5.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 30542fb..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/uniform" -%% click B href "https://github.com/stdlib-js/random-array-uniform/tree/main" -%% click C href "https://github.com/stdlib-js/random-array-uniform/tree/production" -%% click D href "https://github.com/stdlib-js/random-array-uniform/tree/esm" -%% click E href "https://github.com/stdlib-js/random-array-uniform/tree/deno" -%% click F href "https://github.com/stdlib-js/random-array-uniform/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/uniform -[production-url]: https://github.com/stdlib-js/random-array-uniform/tree/production -[deno-url]: https://github.com/stdlib-js/random-array-uniform/tree/deno -[umd-url]: https://github.com/stdlib-js/random-array-uniform/tree/umd -[esm-url]: https://github.com/stdlib-js/random-array-uniform/tree/esm \ No newline at end of file diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 6ecb862..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,192 +0,0 @@ - -{{alias}}( len, a, b[, options] ) - Returns an array containing pseudorandom numbers drawn from a continuous - uniform distribution. - - Parameters - ---------- - len: integer - Output array length. - - a: number - Minimum support. - - b: number - Maximum support. - - 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) - Output array data type. Default: 'float64'. - - Returns - ------- - out: Array|Float64Array|Float32Array - Output array. - - Examples - -------- - > var out = {{alias}}( 3, 2.0, 5.0 ) - - - -{{alias}}.factory( [a, b, ][options] ) - Returns a function for creating arrays containing pseudorandom numbers drawn - from a continuous uniform distribution. - - If provided `a` and `b`, the returned function returns random variates drawn - from the specified distribution. - - If not provided `a` and `b`, the returned function requires that both `a` - and `b` 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. - - 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 ) - - - // Provide `a` and `b`: - > fcn = {{alias}}.factory( 2.0, 5.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 ) - - - // Get a copy of the current state: - > var state = {{alias}}.state - - - > out = {{alias}}( 3, 2.0, 5.0 ) - - > out = {{alias}}( 3, 2.0, 5.0 ) - - - // Set the state: - > {{alias}}.state = state; - - // Regenerate a previous array: - > out = {{alias}}( 3, 2.0, 5.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 99e0868..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,355 +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. -*/ - -import random = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - random( 10, 2, 3 ); // $ExpectType RandomArray - random( 10, 1, 2 ); // $ExpectType RandomArray - random( 10, 1, 2, {} ); // $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 ); // $ExpectError - random( true, 2.0, 5.0 ); // $ExpectError - random( false, 2.0, 5.0 ); // $ExpectError - random( null, 2.0, 5.0 ); // $ExpectError - random( [], 2.0, 5.0 ); // $ExpectError - random( {}, 2.0, 5.0 ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - random( '5', 2.0, 5.0, {} ); // $ExpectError - random( true, 2.0, 5.0, {} ); // $ExpectError - random( false, 2.0, 5.0, {} ); // $ExpectError - random( null, 2.0, 5.0, {} ); // $ExpectError - random( [], 2.0, 5.0, {} ); // $ExpectError - random( {}, 2.0, 5.0, {} ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.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 ); // $ExpectError - random( 10, true, 5.0 ); // $ExpectError - random( 10, false, 5.0 ); // $ExpectError - random( 10, null, 5.0 ); // $ExpectError - random( 10, [], 5.0 ); // $ExpectError - random( 10, {}, 5.0 ); // $ExpectError - random( 10, ( x: number ): number => x, 5.0 ); // $ExpectError - - random( 10, '5', 5.0, {} ); // $ExpectError - random( 10, true, 5.0, {} ); // $ExpectError - random( 10, false, 5.0, {} ); // $ExpectError - random( 10, null, 5.0, {} ); // $ExpectError - random( 10, [], 5.0, {} ); // $ExpectError - random( 10, {}, 5.0, {} ); // $ExpectError - random( 10, ( x: number ): number => x, 5.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' ); // $ExpectError - random( 10, 2.0, true ); // $ExpectError - random( 10, 2.0, false ); // $ExpectError - random( 10, 2.0, null ); // $ExpectError - random( 10, 2.0, [] ); // $ExpectError - random( 10, 2.0, {} ); // $ExpectError - random( 10, 2.0, ( x: number ): number => x ); // $ExpectError - - random( 10, 2.0, '5', {} ); // $ExpectError - random( 10, 2.0, true, {} ); // $ExpectError - random( 10, 2.0, false, {} ); // $ExpectError - random( 10, 2.0, null, {} ); // $ExpectError - random( 10, 2.0, [], {} ); // $ExpectError - random( 10, 2.0, {}, {} ); // $ExpectError - random( 10, 2.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, '5' ); // $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, [] ); // $ExpectError - random( 10, 2.0, 5.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, { 'dtype': 123 } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': null } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - random( 10, 2.0, 5.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 -} - -// Attached to main export is a `factory` method which returns a function... -{ - random.factory( 2.0, 5.0 ); // $ExpectType UnaryFunction - random.factory( 2.0, 5.0, { 'copy': false } ); // $ExpectType UnaryFunction - - random.factory(); // $ExpectType TernaryFunction - random.factory( { 'copy': false } ); // $ExpectType TernaryFunction -} - -// The `factory` method returns a function which returns an array... -{ - const fcn1 = random.factory( 2.0, 5.0 ); - fcn1( 10, ); // $ExpectType RandomArray - - const fcn2 = random.factory(); - fcn2( 10, 2.0, 5.0 ); // $ExpectType RandomArray -} - -// The compiler throws an error if the `factory` method is provided invalid arguments... -{ - random.factory( '5', 5.0 ); // $ExpectError - random.factory( true, 5.0 ); // $ExpectError - random.factory( false, 5.0 ); // $ExpectError - random.factory( [], 5.0 ); // $ExpectError - random.factory( {}, 5.0 ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0 ); // $ExpectError - - random.factory( '5', 5.0, {} ); // $ExpectError - random.factory( true, 5.0, {} ); // $ExpectError - random.factory( false, 5.0, {} ); // $ExpectError - random.factory( [], 5.0, {} ); // $ExpectError - random.factory( {}, 5.0, {} ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0, {} ); // $ExpectError - - random.factory( 2.0, '5' ); // $ExpectError - random.factory( 2.0, true ); // $ExpectError - random.factory( 2.0, false ); // $ExpectError - random.factory( 2.0, [] ); // $ExpectError - random.factory( 2.0, {} ); // $ExpectError - random.factory( 2.0, ( x: number ): number => x ); // $ExpectError - - random.factory( 2.0, '5', {} ); // $ExpectError - random.factory( 2.0, true, {} ); // $ExpectError - random.factory( 2.0, false, {} ); // $ExpectError - random.factory( 2.0, [], {} ); // $ExpectError - random.factory( 2.0, {}, {} ); // $ExpectError - random.factory( 2.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, 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, { 'prng': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'seed': true } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': [ 'a' ] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'state': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': {} } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': true ); // $ExpectError - random.factory( 2.0, 5.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, { 'copy': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'dtype': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - random.factory( 2.0, 5.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, {}, {} ); // $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 ); - 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 ); // $ExpectError - fcn2( false, 2.0, 5.0 ); // $ExpectError - fcn2( '5', 2.0, 5.0 ); // $ExpectError - fcn2( [], 2.0, 5.0 ); // $ExpectError - fcn2( {}, 2.0, 5.0 ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - fcn2( true, 2.0, 5.0, {} ); // $ExpectError - fcn2( false, 2.0, 5.0, {} ); // $ExpectError - fcn2( '5', 2.0, 5.0, {} ); // $ExpectError - fcn2( [], 2.0, 5.0, {} ); // $ExpectError - fcn2( {}, 2.0, 5.0, {} ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0, {} ); // $ExpectError - - fcn2( 10, true, 5.0 ); // $ExpectError - fcn2( 10, false, 5.0 ); // $ExpectError - fcn2( 10, '5', 5.0 ); // $ExpectError - fcn2( 10, [], 5.0 ); // $ExpectError - fcn2( 10, {}, 5.0 ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0 ); // $ExpectError - - fcn2( 10, true, 5.0, {} ); // $ExpectError - fcn2( 10, false, 5.0, {} ); // $ExpectError - fcn2( 10, '5', 5.0, {} ); // $ExpectError - fcn2( 10, [], 5.0, {} ); // $ExpectError - fcn2( 10, {}, 5.0, {} ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0, {} ); // $ExpectError - - fcn2( 10, 2.0, true ); // $ExpectError - fcn2( 10, 2.0, false ); // $ExpectError - fcn2( 10, 2.0, '5' ); // $ExpectError - fcn2( 10, 2.0, [] ); // $ExpectError - fcn2( 10, 2.0, {} ); // $ExpectError - fcn2( 10, 2.0, ( x: number ): number => x ); // $ExpectError - - fcn2( 10, 2.0, true, {} ); // $ExpectError - fcn2( 10, 2.0, false, {} ); // $ExpectError - fcn2( 10, 2.0, '5', {} ); // $ExpectError - fcn2( 10, 2.0, [], {} ); // $ExpectError - fcn2( 10, 2.0, {}, {} ); // $ExpectError - fcn2( 10, 2.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, { 'dtype': 123 } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': null } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError - - const fcn2 = random.factory( 2.0, 5.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 ); - fcn1(); // $ExpectError - fcn1( 1, 1, 1 ); // $ExpectError - - const fcn2 = random.factory(); - fcn2(); // $ExpectError - fcn2( 1 ); // $ExpectError - fcn2( 1, 1, 1, 1 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index c485546..0000000 --- a/examples/index.js +++ /dev/null @@ -1,48 +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'; - -var logEach = require( '@stdlib/console-log-each' ); -var uniform = require( './../lib' ); - -// Create a function for generating random arrays originating from the same state: -var random = uniform.factory( 2.0, 5.0, { - 'state': uniform.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 = uniform.factory( 2.0, 5.0, { - 'state': uniform.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 458c488..7f0bfdf 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 2.0 -/// +/// import { FloatDataType, 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..a4cb981 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-accessor@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-write-accessor@esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-constant-function@esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-noop@v0.0.14-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/random-base-uniform@esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-typed-real-float-ctors@esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-nullary@esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@esm/index.mjs";import f from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.0.2-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/array-typed-real-float-dtypes@esm/index.mjs";import h from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@esm/index.mjs";var u="float64",c=a();function y(e,t){return h(t)?j(t,"dtype")&&(e.dtype=t.dtype,c.indexOf(e.dtype)<0)?new TypeError(f("null3t","dtype",c.join('", "'),e.dtype)):null:new TypeError(f("null2h",t))}function g(){var a,h,j,c,g,b;if(j={dtype:u},0===(h=arguments.length))g=d,c=x;else if(1===h){if(a=arguments[0],g=d.factory(a),b=y(j,a))throw b;c=x}else if(2===h)g=d.factory(arguments[0],arguments[1]),c=v;else if(3===h){if(a=arguments[2],g=d.factory(arguments[0],arguments[1],a),b=y(j,a))throw b;c=v}return a&&a.prng?(e(c,"seed",null),e(c,"seedLength",null),s(c,"state",r(null),i),e(c,"stateLength",null),e(c,"byteLength",null)):(n(c,"seed",w),n(c,"seedLength",L),s(c,"state",P,R),n(c,"stateLength",G),n(c,"byteLength",N)),e(c,"PRNG",g.PRNG),c;function v(e,n){var s,r,i,d;if(!t(e))throw new TypeError(f("null2p",e));if(d={},arguments.length>1&&(r=y(d,n)))throw r;return"generic"===(i=d.dtype||j.dtype)?l(e,g):(s=new(o(i))(e),m([s],[e],[1],g),s)}function x(e,n,s,r){var i,d,m,a;if(!t(e))throw new TypeError(f("null2p",e));if(a={},arguments.length>3&&(d=y(a,r)))throw d;return"generic"===(m=a.dtype||j.dtype)?l(e,h):(i=new(o(m))(e),p([[n],[s],i],[e],[0,0,1],g),i);function h(){return g(n,s)}}function w(){return c.PRNG.seed}function L(){return c.PRNG.seedLength}function G(){return c.PRNG.stateLength}function N(){return c.PRNG.byteLength}function P(){return c.PRNG.state}function R(e){c.PRNG.state=e}}c.push("generic");var b=g();e(b,"factory",g);export{b as default,g as factory}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..4984bd1 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/factory.js","../lib/main.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 dtypes from '@stdlib/array-typed-real-float-dtypes';\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes();\nDTYPES.push( 'generic' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( 'null2h', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( DTYPES.indexOf( opts.dtype ) < 0 ) {\n\t\t\treturn new TypeError( format( 'null3t', 'dtype', DTYPES.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport setReadOnlyAccessor from '@stdlib/utils-define-nonenumerable-read-only-accessor';\nimport setReadWriteAccessor from '@stdlib/utils-define-nonenumerable-read-write-accessor';\nimport constantFunction from '@stdlib/utils-constant-function';\nimport noop from '@stdlib/utils-noop';\nimport base from '@stdlib/random-base-uniform';\nimport ctors from '@stdlib/array-typed-real-float-ctors';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport nullary from '@stdlib/strided-base-nullary';\nimport binary from '@stdlib/strided-base-binary';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution.\n*\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\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 {RangeError} `a` must be less than `b`\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 uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10 );\n* // returns \n*\n* @example\n* var uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nfunction factory() {\n\tvar options;\n\tvar nargs;\n\tvar opts;\n\tvar rand;\n\tvar prng;\n\tvar err;\n\n\topts = {\n\t\t'dtype': defaults.dtype\n\t};\n\n\tnargs = arguments.length;\n\tif ( nargs === 0 ) {\n\t\tprng = base;\n\t\trand = uniform2;\n\t} else if ( nargs === 1 ) {\n\t\toptions = arguments[ 0 ];\n\t\tprng = base.factory( options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform2;\n\t} else if ( nargs === 2 ) {\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ] );\n\t\trand = uniform1;\n\t} else if ( nargs === 3 ) {\n\t\toptions = arguments[ 2 ];\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ], options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform1;\n\t}\n\tif ( options && options.prng ) {\n\t\tsetReadOnly( rand, 'seed', null );\n\t\tsetReadOnly( rand, 'seedLength', null );\n\t\tsetReadWriteAccessor( rand, 'state', constantFunction( null ), noop );\n\t\tsetReadOnly( rand, 'stateLength', null );\n\t\tsetReadOnly( rand, 'byteLength', null );\n\t} else {\n\t\tsetReadOnlyAccessor( rand, 'seed', getSeed );\n\t\tsetReadOnlyAccessor( rand, 'seedLength', getSeedLength );\n\t\tsetReadWriteAccessor( rand, 'state', getState, setState );\n\t\tsetReadOnlyAccessor( rand, 'stateLength', getStateLength );\n\t\tsetReadOnlyAccessor( rand, 'byteLength', getStateSize );\n\t}\n\tsetReadOnly( rand, 'PRNG', prng.PRNG );\n\treturn rand;\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform1( len, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( 'null2p', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 1 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, prng );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tnullary( [ out ], [ len ], [ 1 ], prng );\n\t\treturn out;\n\t}\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {number} a - minimum support\n\t* @param {number} b - maximum support\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform2( len, a, b, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( 'null2p', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 3 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\t// NOTE: we could alternatively use the PRNG factory function to create a PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. Decision made here to avoid this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom number. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in a return value of `NaN`.\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, wrapper );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tbinary( [ [ a ], [ b ], out ], [ len ], [ 0, 0, 1 ], prng );\n\t\treturn out;\n\n\t\t/**\n\t\t* Applies parameters to a pseudorandom number generator function.\n\t\t*\n\t\t* @private\n\t\t* @returns {number} pseudorandom number\n\t\t*/\n\t\tfunction wrapper() {\n\t\t\treturn prng( a, b );\n\t\t}\n\t}\n\n\t/**\n\t* Returns the PRNG seed.\n\t*\n\t* @private\n\t* @returns {PRNGSeedMT19937} seed\n\t*/\n\tfunction getSeed() {\n\t\treturn rand.PRNG.seed;\n\t}\n\n\t/**\n\t* Returns the PRNG seed length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} seed length\n\t*/\n\tfunction getSeedLength() {\n\t\treturn rand.PRNG.seedLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state length\n\t*/\n\tfunction getStateLength() {\n\t\treturn rand.PRNG.stateLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state size (in bytes).\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state size (in bytes)\n\t*/\n\tfunction getStateSize() {\n\t\treturn rand.PRNG.byteLength;\n\t}\n\n\t/**\n\t* Returns the current pseudorandom number generator state.\n\t*\n\t* @private\n\t* @returns {PRNGStateMT19937} current state\n\t*/\n\tfunction getState() {\n\t\treturn rand.PRNG.state;\n\t}\n\n\t/**\n\t* Sets the pseudorandom number generator state.\n\t*\n\t* @private\n\t* @param {PRNGStateMT19937} s - generator state\n\t* @throws {Error} must provide a valid state\n\t*/\n\tfunction setState( s ) {\n\t\trand.PRNG.state = s;\n\t}\n}\n\n\n// EXPORTS //\n\nexport default factory;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @name uniform\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\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 = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar uniform = factory();\n\n\n// EXPORTS //\n\nexport default uniform;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @module @stdlib/random-array-uniform\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.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\" }\n"],"names":["DTYPES","dtypes","validate","opts","options","isObject","hasOwnProp","dtype","indexOf","TypeError","format","join","factory","nargs","rand","prng","err","defaults","arguments","length","base","uniform2","uniform1","setReadOnly","setReadWriteAccessor","constantFunction","noop","setReadOnlyAccessor","getSeed","getSeedLength","getState","setState","getStateLength","getStateSize","PRNG","len","out","dt","o","isNonNegativeInteger","filledBy","ctors","nullary","a","b","wrapper","binary","seed","seedLength","stateLength","byteLength","state","s","push","uniform","main"],"mappings":";;07CA8BIA,EAASC,IAyBb,SAASC,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,WACzBD,EAAKI,MAAQH,EAAQG,MAChBP,EAAOQ,QAASL,EAAKI,OAAU,GAC5B,IAAIE,UAAWC,EAAQ,SAAU,QAASV,EAAOW,KAAM,QAAUR,EAAKI,QAGxE,KARC,IAAIE,UAAWC,EAAQ,SAAUN,GAS1C,CCSA,SAASQ,IACR,IAAIR,EACAS,EACAV,EACAW,EACAC,EACAC,EAOJ,GALAb,EAAO,CACNI,MAASU,GAIK,KADfJ,EAAQK,UAAUC,QAEjBJ,EAAOK,EACPN,EAAOO,OACD,GAAe,IAAVR,EAAc,CAIzB,GAHAT,EAAUc,UAAW,GACrBH,EAAOK,EAAKR,QAASR,GACrBY,EAAMd,EAAUC,EAAMC,GAErB,MAAMY,EAEPF,EAAOO,CACT,MAAQ,GAAe,IAAVR,EACXE,EAAOK,EAAKR,QAASM,UAAW,GAAKA,UAAW,IAChDJ,EAAOQ,OACD,GAAe,IAAVT,EAAc,CAIzB,GAHAT,EAAUc,UAAW,GACrBH,EAAOK,EAAKR,QAASM,UAAW,GAAKA,UAAW,GAAKd,GACrDY,EAAMd,EAAUC,EAAMC,GAErB,MAAMY,EAEPF,EAAOQ,CACP,CAeD,OAdKlB,GAAWA,EAAQW,MACvBQ,EAAaT,EAAM,OAAQ,MAC3BS,EAAaT,EAAM,aAAc,MACjCU,EAAsBV,EAAM,QAASW,EAAkB,MAAQC,GAC/DH,EAAaT,EAAM,cAAe,MAClCS,EAAaT,EAAM,aAAc,QAEjCa,EAAqBb,EAAM,OAAQc,GACnCD,EAAqBb,EAAM,aAAce,GACzCL,EAAsBV,EAAM,QAASgB,EAAUC,GAC/CJ,EAAqBb,EAAM,cAAekB,GAC1CL,EAAqBb,EAAM,aAAcmB,IAE1CV,EAAaT,EAAM,OAAQC,EAAKmB,MACzBpB,EAcP,SAASQ,EAAUa,EAAK/B,GACvB,IACIgC,EACApB,EACAqB,EACAC,EACJ,IAAMC,EAAsBJ,GAC3B,MAAM,IAAI1B,UAAWC,EAAQ,SAAUyB,IAGxC,GADAG,EAAI,CAAA,EACCpB,UAAUC,OAAS,IACvBH,EAAMd,EAAUoC,EAAGlC,IAElB,MAAMY,EAIR,MAAY,aADZqB,EAAKC,EAAE/B,OAASJ,EAAKI,OAEbiC,EAAUL,EAAKpB,IAGvBqB,EAAM,IADCK,EAAOJ,GACR,CAAUF,GAChBO,EAAS,CAAEN,GAAO,CAAED,GAAO,CAAE,GAAKpB,GAC3BqB,EACP,CAgBD,SAASf,EAAUc,EAAKQ,EAAGC,EAAGxC,GAC7B,IACIgC,EACApB,EACAqB,EACAC,EACJ,IAAMC,EAAsBJ,GAC3B,MAAM,IAAI1B,UAAWC,EAAQ,SAAUyB,IAGxC,GADAG,EAAI,CAAA,EACCpB,UAAUC,OAAS,IACvBH,EAAMd,EAAUoC,EAAGlC,IAElB,MAAMY,EAKR,MAAY,aADZqB,EAAKC,EAAE/B,OAASJ,EAAKI,OAEbiC,EAAUL,EAAKU,IAGvBT,EAAM,IADCK,EAAOJ,GACR,CAAUF,GAChBW,EAAQ,CAAE,CAAEH,GAAK,CAAEC,GAAKR,GAAO,CAAED,GAAO,CAAE,EAAG,EAAG,GAAKpB,GAC9CqB,GAQP,SAASS,IACR,OAAO9B,EAAM4B,EAAGC,EAChB,CACD,CAQD,SAAShB,IACR,OAAOd,EAAKoB,KAAKa,IACjB,CAQD,SAASlB,IACR,OAAOf,EAAKoB,KAAKc,UACjB,CAQD,SAAShB,IACR,OAAOlB,EAAKoB,KAAKe,WACjB,CAQD,SAAShB,IACR,OAAOnB,EAAKoB,KAAKgB,UACjB,CAQD,SAASpB,IACR,OAAOhB,EAAKoB,KAAKiB,KACjB,CASD,SAASpB,EAAUqB,GAClBtC,EAAKoB,KAAKiB,MAAQC,CAClB,CACF,CDrPApD,EAAOqD,KAAM,WEqBV,IAACC,EAAU1C,ICiBdW,EAAAgC,EAAA,UAAA3C"} \ No newline at end of file diff --git a/lib/defaults.json b/lib/defaults.json deleted file mode 100644 index 83f4438..0000000 --- a/lib/defaults.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "dtype": "float64" -} diff --git a/lib/factory.js b/lib/factory.js deleted file mode 100644 index 9f232af..0000000 --- a/lib/factory.js +++ /dev/null @@ -1,282 +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 isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var setReadOnlyAccessor = require( '@stdlib/utils-define-nonenumerable-read-only-accessor' ); -var setReadWriteAccessor = require( '@stdlib/utils-define-nonenumerable-read-write-accessor' ); -var constantFunction = require( '@stdlib/utils-constant-function' ); -var noop = require( '@stdlib/utils-noop' ); -var base = require( '@stdlib/random-base-uniform' ); -var ctors = require( '@stdlib/array-typed-real-float-ctors' ); -var filledBy = require( '@stdlib/array-base-filled-by' ); -var nullary = require( '@stdlib/strided-base-nullary' ); -var binary = require( '@stdlib/strided-base-binary' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution. -* -* @param {number} [a] - minimum support -* @param {number} [b] - maximum support -* @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 {RangeError} `a` must be less than `b` -* @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 uniform = factory( 2.0, 5.0 ); -* // returns -* -* var arr = uniform( 10 ); -* // returns -* -* @example -* var uniform = factory( 2.0, 5.0 ); -* // returns -* -* var arr = uniform( 10, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -function factory() { - var options; - var nargs; - var opts; - var rand; - var prng; - var err; - - opts = { - 'dtype': defaults.dtype - }; - - nargs = arguments.length; - if ( nargs === 0 ) { - prng = base; - rand = uniform2; - } else if ( nargs === 1 ) { - options = arguments[ 0 ]; - prng = base.factory( options ); - err = validate( opts, options ); - if ( err ) { - throw err; - } - rand = uniform2; - } else if ( nargs === 2 ) { - prng = base.factory( arguments[ 0 ], arguments[ 1 ] ); - rand = uniform1; - } else if ( nargs === 3 ) { - options = arguments[ 2 ]; - prng = base.factory( arguments[ 0 ], arguments[ 1 ], options ); - err = validate( opts, options ); - if ( err ) { - throw err; - } - rand = uniform1; - } - if ( options && options.prng ) { - setReadOnly( rand, 'seed', null ); - setReadOnly( rand, 'seedLength', null ); - setReadWriteAccessor( rand, 'state', constantFunction( null ), noop ); - setReadOnly( rand, 'stateLength', null ); - setReadOnly( rand, 'byteLength', null ); - } else { - setReadOnlyAccessor( rand, 'seed', getSeed ); - setReadOnlyAccessor( rand, 'seedLength', getSeedLength ); - setReadWriteAccessor( rand, 'state', getState, setState ); - setReadOnlyAccessor( rand, 'stateLength', getStateLength ); - setReadOnlyAccessor( rand, 'byteLength', getStateSize ); - } - setReadOnly( rand, 'PRNG', prng.PRNG ); - return rand; - - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @private - * @param {NonNegativeInteger} len - array length - * @param {Options} [options] - function options - * @param {string} [options.dtype] - 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 - */ - function uniform1( len, options ) { - var ctor; - var out; - var err; - var dt; - var o; - if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( 'null2p', len ) ); - } - o = {}; - if ( arguments.length > 1 ) { - err = validate( o, options ); - if ( err ) { - throw err; - } - } - dt = o.dtype || opts.dtype; - if ( dt === 'generic' ) { - return filledBy( len, prng ); - } - ctor = ctors( dt ); - out = new ctor( len ); - nullary( [ out ], [ len ], [ 1 ], prng ); - return out; - } - - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @private - * @param {NonNegativeInteger} len - array length - * @param {number} a - minimum support - * @param {number} b - maximum support - * @param {Options} [options] - function options - * @param {string} [options.dtype] - 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 - */ - function uniform2( len, a, b, options ) { - var ctor; - var out; - var err; - var dt; - var o; - if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( 'null2p', len ) ); - } - o = {}; - if ( arguments.length > 3 ) { - err = validate( o, options ); - if ( err ) { - throw err; - } - } - // NOTE: we could alternatively use the PRNG factory function to create a PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. Decision made here to avoid this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom number. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in a return value of `NaN`. - dt = o.dtype || opts.dtype; - if ( dt === 'generic' ) { - return filledBy( len, wrapper ); - } - ctor = ctors( dt ); - out = new ctor( len ); - binary( [ [ a ], [ b ], out ], [ len ], [ 0, 0, 1 ], prng ); - return out; - - /** - * Applies parameters to a pseudorandom number generator function. - * - * @private - * @returns {number} pseudorandom number - */ - function wrapper() { - return prng( a, b ); - } - } - - /** - * Returns the PRNG seed. - * - * @private - * @returns {PRNGSeedMT19937} seed - */ - function getSeed() { - return rand.PRNG.seed; - } - - /** - * Returns the PRNG seed length. - * - * @private - * @returns {PositiveInteger} seed length - */ - function getSeedLength() { - return rand.PRNG.seedLength; - } - - /** - * Returns the PRNG state length. - * - * @private - * @returns {PositiveInteger} state length - */ - function getStateLength() { - return rand.PRNG.stateLength; - } - - /** - * Returns the PRNG state size (in bytes). - * - * @private - * @returns {PositiveInteger} state size (in bytes) - */ - function getStateSize() { - return rand.PRNG.byteLength; - } - - /** - * Returns the current pseudorandom number generator state. - * - * @private - * @returns {PRNGStateMT19937} current state - */ - function getState() { - return rand.PRNG.state; - } - - /** - * Sets the pseudorandom number generator state. - * - * @private - * @param {PRNGStateMT19937} s - generator state - * @throws {Error} must provide a valid state - */ - function setState( s ) { - rand.PRNG.state = s; - } -} - - -// EXPORTS // - -module.exports = factory; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 0077f00..0000000 --- a/lib/index.js +++ /dev/null @@ -1,77 +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'; - -/** -* Create an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. -* -* @module @stdlib/random-array-uniform -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var arr = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var arr = uniform( 10, 2.0, 5.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var rand = uniform.factory( 2.0, 5.0 ); -* // returns -* -* var arr = rand( 10 ); -* // returns -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var rand = uniform.factory( 2.0, 5.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" } diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index da0d9b1..0000000 --- a/lib/main.js +++ /dev/null @@ -1,58 +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 factory = require( './factory.js' ); - - -// MAIN // - -/** -* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. -* -* @name uniform -* @type {Function} -* @param {NonNegativeInteger} len - array length -* @param {number} a - minimum support -* @param {number} b - maximum support -* @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 = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var arr = uniform( 10, 2.0, 5.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -var uniform = factory(); - - -// EXPORTS // - -module.exports = uniform; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index 3629aaf..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,72 +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 dtypes = require( '@stdlib/array-typed-real-float-dtypes' ); -var isObject = require( '@stdlib/assert-is-plain-object' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// VARIABLES // - -var DTYPES = dtypes(); -DTYPES.push( 'generic' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Options} options - function options -* @param {string} [options.dtype] - output array data type -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var options = { -* 'dtype': 'float64' -* }; -* var err = validate( opts, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( 'null2h', options ) ); - } - if ( hasOwnProp( options, 'dtype' ) ) { - opts.dtype = options.dtype; - if ( DTYPES.indexOf( opts.dtype ) < 0 ) { - return new TypeError( format( 'null3t', 'dtype', DTYPES.join( '", "' ), opts.dtype ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index 8b6d28d..621da6a 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 continuous uniform 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,55 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-filled-by": "^0.0.2", - "@stdlib/array-typed-real-float-ctors": "^0.0.1", - "@stdlib/array-typed-real-float-dtypes": "^0.0.1", - "@stdlib/assert-has-own-property": "^0.0.7", - "@stdlib/assert-is-nonnegative-integer": "^0.0.7", - "@stdlib/assert-is-plain-object": "^0.0.7", - "@stdlib/random-base-uniform": "^0.0.6", - "@stdlib/strided-base-binary": "^0.0.8", - "@stdlib/strided-base-nullary": "^0.0.7", - "@stdlib/error-tools-fmtprodmsg": "^0.0.2", - "@stdlib/types": "^0.0.14", - "@stdlib/utils-constant-function": "^0.0.8", - "@stdlib/utils-define-nonenumerable-read-only-accessor": "^0.0.7", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.7", - "@stdlib/utils-define-nonenumerable-read-write-accessor": "^0.0.7", - "@stdlib/utils-noop": "^0.0.14" - }, - "devDependencies": { - "@stdlib/array-float32": "^0.0.6", - "@stdlib/array-float64": "^0.0.6", - "@stdlib/array-uint32": "^0.0.6", - "@stdlib/assert-is-uint32array": "^0.0.8", - "@stdlib/bench": "^0.0.12", - "@stdlib/console-log-each": "^0.0.2", - "@stdlib/constants-uint32-max": "^0.0.7", - "@stdlib/math-base-assert-is-nan": "^0.0.8", - "@stdlib/math-base-assert-is-nanf": "^0.0.8", - "@stdlib/math-base-special-pow": "^0.0.7", - "@stdlib/random-base-minstd": "^0.0.6", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdmath", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..fc726ec --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/test.factory.js b/test/test.factory.js deleted file mode 100644 index a869e75..0000000 --- a/test/test.factory.js +++ /dev/null @@ -1,1328 +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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -tape( 'the function throws an error if the second distribution parameter is less than the first distribution parameter', function test( t ) { - var values; - var i; - - values = [ - [ 0.0, 0.0 ], - [ -2.0, -4.0 ], - [ 2.0, 1.0 ] - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( arr ) { - return function badValue() { - factory( arr[0], arr[1] ); - }; - } -}); - -tape( 'the function throws an error if the second distribution parameter is less than the first distribution parameter (options)', function test( t ) { - var values; - var i; - - values = [ - [ 0.0, 0.0 ], - [ -2.0, -4.0 ], - [ 2.0, 1.0 ] - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( arr ) { - return function badValue() { - factory( arr[0], arr[1], {} ); - }; - } -}); - -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, 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, { - '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, { - '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, { - '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, { - '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, { - '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, { - '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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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 ); - - 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 ); - - 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, { - '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 ); - - 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 ); - 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( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory(); - actual = random( 10, 2.0, 5.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( typeof actual[ i ], 'number', '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 ); - - 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 ); - - 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 ); - - 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 that generates `NaN` values if the first distribution parameter is greater than or equal to the second distribution parameter', function test( t ) { - var random; - var values; - var actual; - var i; - var j; - - random = factory(); - values = [ - [ 2.0, 1.0 ], - [ -3.0, -4.0 ], - [ 0.0, 0.0 ] - ]; - - for ( i = 0; i < values.length; i++ ) { - actual = random( 10, values[ i ][ 0 ], values[ i ][ 1 ] ); - for ( j = 0; j < actual.length; j++ ) { - t.strictEqual( isnan( actual[ j ] ), true, 'returns expected value when provided '+values[ 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, { - '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 ); - - 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, { - '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( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'float64' - }); - actual = random( 10, 2.0, 5.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( typeof actual[ i ], 'number', '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, { - '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( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'float32' - }); - actual = random( 10, 2.0, 5.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( typeof actual[ i ], 'number', '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, { - '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 ); - - 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, { - '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, { - '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 ); - - // 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, { - '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 ); - - // 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, { - '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 ); - - 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, { - 'prng': randu.normalized - }); - - randu = minstd.factory({ - 'seed': seed - }); - random2 = factory( 2.0, 5.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 ); - arr2 = random2( 10, 2.0, 5.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 c4fb6d3..0000000 --- a/test/test.js +++ /dev/null @@ -1,69 +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 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 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 37b0080..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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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, 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, { - '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 ); - - 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( typeof actual[ i ], 'number', '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, { - '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( typeof actual[ i ], 'number', '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, { - '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( typeof actual[ i ], 'number', '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, { - '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 ); - } - // Capture the current state: - state = random.state; - - // Move to a future state... - arr = random( 10, 2.0, 5.0 ); - for ( i = 0; i < 100; i++ ) { - random( 2, 2.0, 5.0 ); - } - // Set the state: - random.state = state; - - // Replay previously generated values: - t.deepEqual( random( 10, 2.0, 5.0 ), arr, 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.validate.js b/test/test.validate.js deleted file mode 100644 index c515526..0000000 --- a/test/test.validate.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 validate = require( './../lib/validate.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.equal( typeof validate, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function returns an error if provided an options argument which is not an object', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - void 0, - null, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, values[ i ] ); - t.equal( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided a `dtype` option which is not a supported data type', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - -5, - NaN, - true, - false, - void 0, - null, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, { - 'dtype': values[ i ] - }); - t.equal( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns null if all options are valid', function test( t ) { - var options; - var opts; - var err; - - options = { - 'dtype': 'float64' - }; - opts = {}; - err = validate( opts, options ); - - t.equal( err, null, 'returns null' ); - t.deepEqual( opts, options, 'sets option values' ); - - t.end(); -}); - -tape( 'the function ignores unrecognized/unsupported options', function test( t ) { - var options; - var opts; - var err; - - options = { - 'beep': true, - 'boop': 'bop' - }; - opts = {}; - err = validate( opts, options ); - - t.equal( err, null, 'returns null' ); - t.deepEqual( opts, {}, 'does not set any option values' ); - t.end(); -}); From 09a73dd9b0c7b454662ae30ba94f5332e231504a Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 11 Feb 2023 01:25:53 +0000 Subject: [PATCH 09/82] Transform error messages --- lib/factory.js | 6 +++--- lib/validate.js | 6 +++--- package.json | 2 +- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/lib/factory.js b/lib/factory.js index 22ec236..9f232af 100644 --- a/lib/factory.js +++ b/lib/factory.js @@ -31,7 +31,7 @@ var ctors = require( '@stdlib/array-typed-real-float-ctors' ); var filledBy = require( '@stdlib/array-base-filled-by' ); var nullary = require( '@stdlib/strided-base-nullary' ); var binary = require( '@stdlib/strided-base-binary' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -144,7 +144,7 @@ function factory() { var dt; var o; if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) ); + throw new TypeError( format( 'null2p', len ) ); } o = {}; if ( arguments.length > 1 ) { @@ -184,7 +184,7 @@ function factory() { var dt; var o; if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) ); + throw new TypeError( format( 'null2p', len ) ); } o = {}; if ( arguments.length > 3 ) { diff --git a/lib/validate.js b/lib/validate.js index 40b9723..3629aaf 100644 --- a/lib/validate.js +++ b/lib/validate.js @@ -23,7 +23,7 @@ var dtypes = require( '@stdlib/array-typed-real-float-dtypes' ); var isObject = require( '@stdlib/assert-is-plain-object' ); var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // VARIABLES // @@ -55,12 +55,12 @@ DTYPES.push( 'generic' ); */ function validate( opts, options ) { if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); + return new TypeError( format( 'null2h', options ) ); } if ( hasOwnProp( options, 'dtype' ) ) { opts.dtype = options.dtype; if ( DTYPES.indexOf( opts.dtype ) < 0 ) { - return new TypeError( format( 'invalid option. `%s` option must be one of the following: "%s". Option: `%s`.', 'dtype', DTYPES.join( '", "' ), opts.dtype ) ); + return new TypeError( format( 'null3t', 'dtype', DTYPES.join( '", "' ), opts.dtype ) ); } } return null; diff --git a/package.json b/package.json index 486f4d2..8b6d28d 100644 --- a/package.json +++ b/package.json @@ -46,7 +46,7 @@ "@stdlib/random-base-uniform": "^0.0.6", "@stdlib/strided-base-binary": "^0.0.8", "@stdlib/strided-base-nullary": "^0.0.7", - "@stdlib/string-format": "^0.0.3", + "@stdlib/error-tools-fmtprodmsg": "^0.0.2", "@stdlib/types": "^0.0.14", "@stdlib/utils-constant-function": "^0.0.8", "@stdlib/utils-define-nonenumerable-read-only-accessor": "^0.0.7", From 74586e63bd0cac33b44e15f5cf103ed740c73590 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 11 Feb 2023 01:30:52 +0000 Subject: [PATCH 10/82] Remove files --- index.d.ts | 245 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6427 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 7f0bfdf..0000000 --- a/index.d.ts +++ /dev/null @@ -1,245 +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. -*/ - -// TypeScript Version: 2.0 - -/// - -import { FloatDataType, FloatTypedArray } from '@stdlib/types/array'; -import * as random from '@stdlib/types/random'; - -/** -* Supported data types. -*/ -type DataType = FloatDataType | 'generic'; - -/** -* 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 { - /** - * Default output array data type. Default: 'float64'. - */ - 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 continuous uniform distribution with pre-specified parameter values. -*/ -interface UnaryFunction extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @param len - array length - * @param options - function options - * @returns output array - */ - ( len: number, options?: Options ): RandomArray; -} - -/** -* Interface for generating pseudorandom numbers drawn from a continuous uniform distribution without pre-specified parameter values. -*/ -interface TernaryFunction extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @param len - array length - * @param a - minimum support - * @param b - maximum support - * @param options - function options - * @returns output array - */ - ( len: number, a: number, b: number, options?: Options ): RandomArray; -} - -/** -* Interface for generating pseudorandom numbers drawn from a uniform distribution. -*/ -interface Random extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @param len - array length - * @param a - minimum support - * @param b - maximum support - * @param options - function options - * @returns output array - * - * @example - * var out = uniform( 10, 2.0, 5.0 ); - * // returns - */ - ( len: number, a: number, b: number, options?: Options ): RandomArray; - - /** - * Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution. - * - * ## Notes - * - * - When provided `a` and `b`, the returned function returns random variates drawn from the specified distribution. - * - * @param a - minimum support - * @param b - maximum support - * @param options - function options - * @throws `a` must be less than `b` - * @throws must provide a valid state - * @returns function for creating arrays - * - * @example - * var random = uniform.factory( 2.0, 5.0 ); - * - * var out = random( 10 ); - * // returns - * - * @example - * var random = uniform.factory( 2.0, 5.0, { - * 'seed': 297 - * }); - * var out = random( 10 ); - * // returns - */ - factory( a: number, b: number, options?: FactoryOptions ): UnaryFunction; - - /** - * Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution. - * - * ## Notes - * - * - When not provided `a` and `b`, the returned function requires that both `a` and `b` be provided at each invocation. - * - * @param options - function options - * @throws must provide a valid state - * @returns function for creating arrays - * - * @example - * var random = uniform.factory(); - * - * var out = random( 10, 2.0, 5.0 ); - * // returns - * - * @example - * var random = uniform.factory({ - * 'seed': 297 - * }); - * var out = random( 10, 2.0, 5.0 ); - * // returns - */ - factory( options?: FactoryOptions ): TernaryFunction; -} - -/** -* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. -* -* @param len - array length -* @param a - minimum support -* @param b - maximum support -* @param options - function options -* @returns output array -* -* @example -* var out = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var random = uniform.factory( 2.0, 5.0 ); -* -* var out = random( 10 ); -* // returns -*/ -declare var uniform: Random; - - -// EXPORTS // - -export = uniform; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index a4cb981..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-accessor@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-write-accessor@esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-constant-function@esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-noop@v0.0.14-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/random-base-uniform@esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-typed-real-float-ctors@esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-nullary@esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@esm/index.mjs";import f from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.0.2-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/array-typed-real-float-dtypes@esm/index.mjs";import h from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@esm/index.mjs";var u="float64",c=a();function y(e,t){return h(t)?j(t,"dtype")&&(e.dtype=t.dtype,c.indexOf(e.dtype)<0)?new TypeError(f("null3t","dtype",c.join('", "'),e.dtype)):null:new TypeError(f("null2h",t))}function g(){var a,h,j,c,g,b;if(j={dtype:u},0===(h=arguments.length))g=d,c=x;else if(1===h){if(a=arguments[0],g=d.factory(a),b=y(j,a))throw b;c=x}else if(2===h)g=d.factory(arguments[0],arguments[1]),c=v;else if(3===h){if(a=arguments[2],g=d.factory(arguments[0],arguments[1],a),b=y(j,a))throw b;c=v}return a&&a.prng?(e(c,"seed",null),e(c,"seedLength",null),s(c,"state",r(null),i),e(c,"stateLength",null),e(c,"byteLength",null)):(n(c,"seed",w),n(c,"seedLength",L),s(c,"state",P,R),n(c,"stateLength",G),n(c,"byteLength",N)),e(c,"PRNG",g.PRNG),c;function v(e,n){var s,r,i,d;if(!t(e))throw new TypeError(f("null2p",e));if(d={},arguments.length>1&&(r=y(d,n)))throw r;return"generic"===(i=d.dtype||j.dtype)?l(e,g):(s=new(o(i))(e),m([s],[e],[1],g),s)}function x(e,n,s,r){var i,d,m,a;if(!t(e))throw new TypeError(f("null2p",e));if(a={},arguments.length>3&&(d=y(a,r)))throw d;return"generic"===(m=a.dtype||j.dtype)?l(e,h):(i=new(o(m))(e),p([[n],[s],i],[e],[0,0,1],g),i);function h(){return g(n,s)}}function w(){return c.PRNG.seed}function L(){return c.PRNG.seedLength}function G(){return c.PRNG.stateLength}function N(){return c.PRNG.byteLength}function P(){return c.PRNG.state}function R(e){c.PRNG.state=e}}c.push("generic");var b=g();e(b,"factory",g);export{b as default,g as factory}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 4984bd1..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/factory.js","../lib/main.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 dtypes from '@stdlib/array-typed-real-float-dtypes';\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes();\nDTYPES.push( 'generic' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( 'null2h', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( DTYPES.indexOf( opts.dtype ) < 0 ) {\n\t\t\treturn new TypeError( format( 'null3t', 'dtype', DTYPES.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport setReadOnlyAccessor from '@stdlib/utils-define-nonenumerable-read-only-accessor';\nimport setReadWriteAccessor from '@stdlib/utils-define-nonenumerable-read-write-accessor';\nimport constantFunction from '@stdlib/utils-constant-function';\nimport noop from '@stdlib/utils-noop';\nimport base from '@stdlib/random-base-uniform';\nimport ctors from '@stdlib/array-typed-real-float-ctors';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport nullary from '@stdlib/strided-base-nullary';\nimport binary from '@stdlib/strided-base-binary';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution.\n*\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\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 {RangeError} `a` must be less than `b`\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 uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10 );\n* // returns \n*\n* @example\n* var uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nfunction factory() {\n\tvar options;\n\tvar nargs;\n\tvar opts;\n\tvar rand;\n\tvar prng;\n\tvar err;\n\n\topts = {\n\t\t'dtype': defaults.dtype\n\t};\n\n\tnargs = arguments.length;\n\tif ( nargs === 0 ) {\n\t\tprng = base;\n\t\trand = uniform2;\n\t} else if ( nargs === 1 ) {\n\t\toptions = arguments[ 0 ];\n\t\tprng = base.factory( options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform2;\n\t} else if ( nargs === 2 ) {\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ] );\n\t\trand = uniform1;\n\t} else if ( nargs === 3 ) {\n\t\toptions = arguments[ 2 ];\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ], options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform1;\n\t}\n\tif ( options && options.prng ) {\n\t\tsetReadOnly( rand, 'seed', null );\n\t\tsetReadOnly( rand, 'seedLength', null );\n\t\tsetReadWriteAccessor( rand, 'state', constantFunction( null ), noop );\n\t\tsetReadOnly( rand, 'stateLength', null );\n\t\tsetReadOnly( rand, 'byteLength', null );\n\t} else {\n\t\tsetReadOnlyAccessor( rand, 'seed', getSeed );\n\t\tsetReadOnlyAccessor( rand, 'seedLength', getSeedLength );\n\t\tsetReadWriteAccessor( rand, 'state', getState, setState );\n\t\tsetReadOnlyAccessor( rand, 'stateLength', getStateLength );\n\t\tsetReadOnlyAccessor( rand, 'byteLength', getStateSize );\n\t}\n\tsetReadOnly( rand, 'PRNG', prng.PRNG );\n\treturn rand;\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform1( len, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( 'null2p', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 1 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, prng );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tnullary( [ out ], [ len ], [ 1 ], prng );\n\t\treturn out;\n\t}\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {number} a - minimum support\n\t* @param {number} b - maximum support\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform2( len, a, b, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( 'null2p', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 3 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\t// NOTE: we could alternatively use the PRNG factory function to create a PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. Decision made here to avoid this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom number. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in a return value of `NaN`.\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, wrapper );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tbinary( [ [ a ], [ b ], out ], [ len ], [ 0, 0, 1 ], prng );\n\t\treturn out;\n\n\t\t/**\n\t\t* Applies parameters to a pseudorandom number generator function.\n\t\t*\n\t\t* @private\n\t\t* @returns {number} pseudorandom number\n\t\t*/\n\t\tfunction wrapper() {\n\t\t\treturn prng( a, b );\n\t\t}\n\t}\n\n\t/**\n\t* Returns the PRNG seed.\n\t*\n\t* @private\n\t* @returns {PRNGSeedMT19937} seed\n\t*/\n\tfunction getSeed() {\n\t\treturn rand.PRNG.seed;\n\t}\n\n\t/**\n\t* Returns the PRNG seed length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} seed length\n\t*/\n\tfunction getSeedLength() {\n\t\treturn rand.PRNG.seedLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state length\n\t*/\n\tfunction getStateLength() {\n\t\treturn rand.PRNG.stateLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state size (in bytes).\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state size (in bytes)\n\t*/\n\tfunction getStateSize() {\n\t\treturn rand.PRNG.byteLength;\n\t}\n\n\t/**\n\t* Returns the current pseudorandom number generator state.\n\t*\n\t* @private\n\t* @returns {PRNGStateMT19937} current state\n\t*/\n\tfunction getState() {\n\t\treturn rand.PRNG.state;\n\t}\n\n\t/**\n\t* Sets the pseudorandom number generator state.\n\t*\n\t* @private\n\t* @param {PRNGStateMT19937} s - generator state\n\t* @throws {Error} must provide a valid state\n\t*/\n\tfunction setState( s ) {\n\t\trand.PRNG.state = s;\n\t}\n}\n\n\n// EXPORTS //\n\nexport default factory;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @name uniform\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\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 = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar uniform = factory();\n\n\n// EXPORTS //\n\nexport default uniform;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @module @stdlib/random-array-uniform\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.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\" }\n"],"names":["DTYPES","dtypes","validate","opts","options","isObject","hasOwnProp","dtype","indexOf","TypeError","format","join","factory","nargs","rand","prng","err","defaults","arguments","length","base","uniform2","uniform1","setReadOnly","setReadWriteAccessor","constantFunction","noop","setReadOnlyAccessor","getSeed","getSeedLength","getState","setState","getStateLength","getStateSize","PRNG","len","out","dt","o","isNonNegativeInteger","filledBy","ctors","nullary","a","b","wrapper","binary","seed","seedLength","stateLength","byteLength","state","s","push","uniform","main"],"mappings":";;07CA8BIA,EAASC,IAyBb,SAASC,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,WACzBD,EAAKI,MAAQH,EAAQG,MAChBP,EAAOQ,QAASL,EAAKI,OAAU,GAC5B,IAAIE,UAAWC,EAAQ,SAAU,QAASV,EAAOW,KAAM,QAAUR,EAAKI,QAGxE,KARC,IAAIE,UAAWC,EAAQ,SAAUN,GAS1C,CCSA,SAASQ,IACR,IAAIR,EACAS,EACAV,EACAW,EACAC,EACAC,EAOJ,GALAb,EAAO,CACNI,MAASU,GAIK,KADfJ,EAAQK,UAAUC,QAEjBJ,EAAOK,EACPN,EAAOO,OACD,GAAe,IAAVR,EAAc,CAIzB,GAHAT,EAAUc,UAAW,GACrBH,EAAOK,EAAKR,QAASR,GACrBY,EAAMd,EAAUC,EAAMC,GAErB,MAAMY,EAEPF,EAAOO,CACT,MAAQ,GAAe,IAAVR,EACXE,EAAOK,EAAKR,QAASM,UAAW,GAAKA,UAAW,IAChDJ,EAAOQ,OACD,GAAe,IAAVT,EAAc,CAIzB,GAHAT,EAAUc,UAAW,GACrBH,EAAOK,EAAKR,QAASM,UAAW,GAAKA,UAAW,GAAKd,GACrDY,EAAMd,EAAUC,EAAMC,GAErB,MAAMY,EAEPF,EAAOQ,CACP,CAeD,OAdKlB,GAAWA,EAAQW,MACvBQ,EAAaT,EAAM,OAAQ,MAC3BS,EAAaT,EAAM,aAAc,MACjCU,EAAsBV,EAAM,QAASW,EAAkB,MAAQC,GAC/DH,EAAaT,EAAM,cAAe,MAClCS,EAAaT,EAAM,aAAc,QAEjCa,EAAqBb,EAAM,OAAQc,GACnCD,EAAqBb,EAAM,aAAce,GACzCL,EAAsBV,EAAM,QAASgB,EAAUC,GAC/CJ,EAAqBb,EAAM,cAAekB,GAC1CL,EAAqBb,EAAM,aAAcmB,IAE1CV,EAAaT,EAAM,OAAQC,EAAKmB,MACzBpB,EAcP,SAASQ,EAAUa,EAAK/B,GACvB,IACIgC,EACApB,EACAqB,EACAC,EACJ,IAAMC,EAAsBJ,GAC3B,MAAM,IAAI1B,UAAWC,EAAQ,SAAUyB,IAGxC,GADAG,EAAI,CAAA,EACCpB,UAAUC,OAAS,IACvBH,EAAMd,EAAUoC,EAAGlC,IAElB,MAAMY,EAIR,MAAY,aADZqB,EAAKC,EAAE/B,OAASJ,EAAKI,OAEbiC,EAAUL,EAAKpB,IAGvBqB,EAAM,IADCK,EAAOJ,GACR,CAAUF,GAChBO,EAAS,CAAEN,GAAO,CAAED,GAAO,CAAE,GAAKpB,GAC3BqB,EACP,CAgBD,SAASf,EAAUc,EAAKQ,EAAGC,EAAGxC,GAC7B,IACIgC,EACApB,EACAqB,EACAC,EACJ,IAAMC,EAAsBJ,GAC3B,MAAM,IAAI1B,UAAWC,EAAQ,SAAUyB,IAGxC,GADAG,EAAI,CAAA,EACCpB,UAAUC,OAAS,IACvBH,EAAMd,EAAUoC,EAAGlC,IAElB,MAAMY,EAKR,MAAY,aADZqB,EAAKC,EAAE/B,OAASJ,EAAKI,OAEbiC,EAAUL,EAAKU,IAGvBT,EAAM,IADCK,EAAOJ,GACR,CAAUF,GAChBW,EAAQ,CAAE,CAAEH,GAAK,CAAEC,GAAKR,GAAO,CAAED,GAAO,CAAE,EAAG,EAAG,GAAKpB,GAC9CqB,GAQP,SAASS,IACR,OAAO9B,EAAM4B,EAAGC,EAChB,CACD,CAQD,SAAShB,IACR,OAAOd,EAAKoB,KAAKa,IACjB,CAQD,SAASlB,IACR,OAAOf,EAAKoB,KAAKc,UACjB,CAQD,SAAShB,IACR,OAAOlB,EAAKoB,KAAKe,WACjB,CAQD,SAAShB,IACR,OAAOnB,EAAKoB,KAAKgB,UACjB,CAQD,SAASpB,IACR,OAAOhB,EAAKoB,KAAKiB,KACjB,CASD,SAASpB,EAAUqB,GAClBtC,EAAKoB,KAAKiB,MAAQC,CAClB,CACF,CDrPApD,EAAOqD,KAAM,WEqBV,IAACC,EAAU1C,ICiBdW,EAAAgC,EAAA,UAAA3C"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index fc726ec..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 61af8809f8832f98ca4f0d49ed0be583e35bccf9 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 11 Feb 2023 01:31:43 +0000 Subject: [PATCH 11/82] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 62 - .github/workflows/cancel.yml | 56 - .github/workflows/close_pull_requests.yml | 44 - .github/workflows/examples.yml | 62 - .github/workflows/npm_downloads.yml | 108 - .github/workflows/productionize.yml | 798 --- .github/workflows/publish.yml | 236 - .github/workflows/test.yml | 97 - .github/workflows/test_bundles.yml | 180 - .github/workflows/test_coverage.yml | 123 - .github/workflows/test_install.yml | 83 - .gitignore | 184 - .npmignore | 227 - .npmrc | 28 - CHANGELOG.md | 5 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 61 +- benchmark/benchmark.float32.factory.js | 96 - benchmark/benchmark.float32.js | 98 - benchmark/benchmark.float64.factory.js | 96 - benchmark/benchmark.float64.js | 98 - benchmark/benchmark.generic.factory.js | 96 - benchmark/benchmark.generic.js | 98 - branches.md | 53 - docs/repl.txt | 192 - docs/types/test.ts | 355 -- examples/index.js | 48 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/defaults.json | 3 - lib/factory.js | 282 - lib/index.js | 77 - lib/main.js | 58 - lib/validate.js | 72 - package.json | 76 +- stats.html | 6177 +++++++++++++++++++++ test/test.factory.js | 1328 ----- test/test.js | 69 - test/test.main.js | 244 - test/test.validate.js | 118 - 47 files changed, 6215 insertions(+), 6658 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 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 benchmark/benchmark.float32.factory.js delete mode 100644 benchmark/benchmark.float32.js delete mode 100644 benchmark/benchmark.float64.factory.js delete mode 100644 benchmark/benchmark.float64.js delete mode 100644 benchmark/benchmark.generic.factory.js delete mode 100644 benchmark/benchmark.generic.js delete mode 100644 branches.md 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/defaults.json delete mode 100644 lib/factory.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/test.factory.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js delete mode 100644 test/test.validate.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 0fd4d6c..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 `tslint.json` files: -[tslint.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 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 c4ab52b..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/uniform) 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 06a9a75..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,62 +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' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 a00dbe5..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,56 +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' - uses: styfle/cancel-workflow-action@0.11.0 - 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 7eca213..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,44 +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: - run: - runs-on: ubuntu-latest - steps: - - uses: superbrothers/close-pull-request@v3 - 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/uniform) 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 7902a7d..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,62 +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 the repository: - - name: 'Checkout the repository' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 818b9df..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,108 +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: '33 9 * * 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' - uses: actions/checkout@v3 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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' - uses: actions/upload-artifact@v3 - 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' - uses: distributhor/workflow-webhook@v3 - 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 3e8e2db..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,798 +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' - uses: actions/checkout@v3 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 - - # Format error messages: - - name: 'Replace double quotes with single quotes in rewritten format string error messages' - run: | - find . -name "*.js" -exec sed -E -i "s/Error\( format\( \"([a-zA-Z0-9]+)\"/Error\( format\( '\1'/g" {} \; - - # Format string literal error messages: - - name: 'Replace double quotes with single quotes in rewritten string literal error messages' - run: | - find . -name "*.js" -exec sed -E -i "s/Error\( format\(\"([a-zA-Z0-9]+)\"\)/Error\( format\( '\1' \)/g" {} \; - - # Format code: - - name: 'Replace double quotes with single quotes in inserted `require` calls' - run: | - find . -name "*.js" -exec sed -E -i "s/require\( ?\"@stdlib\/error-tools-fmtprodmsg\" ?\);/require\( '@stdlib\/error-tools-fmtprodmsg' \);/g" {} \; - - # 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' }} - uses: actions/checkout@v3 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - uses: actions/setup-node@v3 - with: - node-version: 16 - 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' - uses: actions/checkout@v3 - - # 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' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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' - uses: act10ns/slack@v1 - 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' - uses: actions/checkout@v3 - - # 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' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 + + ```
@@ -364,7 +363,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]. @@ -424,13 +423,13 @@ Copyright © 2016-2023. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/random-array-uniform/main/LICENSE -[@stdlib/random/base/uniform]: https://github.com/stdlib-js/random-base-uniform +[@stdlib/random/base/uniform]: https://github.com/stdlib-js/random-base-uniform/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/benchmark/benchmark.float32.factory.js b/benchmark/benchmark.float32.factory.js deleted file mode 100644 index 67e61f4..0000000 --- a/benchmark/benchmark.float32.factory.js +++ /dev/null @@ -1,96 +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 bench = require( '@stdlib/bench' ); -var isnanf = require( '@stdlib/math-base-assert-is-nanf' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var fcn = uniform.factory( 2.0, 5.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 4642816..0000000 --- a/benchmark/benchmark.float32.js +++ /dev/null @@ -1,98 +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 bench = require( '@stdlib/bench' ); -var isnanf = require( '@stdlib/math-base-assert-is-nanf' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = 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 = uniform( len, 2.0, 5.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.factory.js b/benchmark/benchmark.float64.factory.js deleted file mode 100644 index 8646a54..0000000 --- a/benchmark/benchmark.float64.factory.js +++ /dev/null @@ -1,96 +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 bench = require( '@stdlib/bench' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var fcn = uniform.factory( 2.0, 5.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 5ee0d97..0000000 --- a/benchmark/benchmark.float64.js +++ /dev/null @@ -1,98 +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 bench = require( '@stdlib/bench' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = 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 = uniform( len, 2.0, 5.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.factory.js b/benchmark/benchmark.generic.factory.js deleted file mode 100644 index 7020d62..0000000 --- a/benchmark/benchmark.generic.factory.js +++ /dev/null @@ -1,96 +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 bench = require( '@stdlib/bench' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var fcn = uniform.factory( 2.0, 5.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 06a2a83..0000000 --- a/benchmark/benchmark.generic.js +++ /dev/null @@ -1,98 +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 bench = require( '@stdlib/bench' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = 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 = uniform( len, 2.0, 5.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 30542fb..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/uniform" -%% click B href "https://github.com/stdlib-js/random-array-uniform/tree/main" -%% click C href "https://github.com/stdlib-js/random-array-uniform/tree/production" -%% click D href "https://github.com/stdlib-js/random-array-uniform/tree/esm" -%% click E href "https://github.com/stdlib-js/random-array-uniform/tree/deno" -%% click F href "https://github.com/stdlib-js/random-array-uniform/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/uniform -[production-url]: https://github.com/stdlib-js/random-array-uniform/tree/production -[deno-url]: https://github.com/stdlib-js/random-array-uniform/tree/deno -[umd-url]: https://github.com/stdlib-js/random-array-uniform/tree/umd -[esm-url]: https://github.com/stdlib-js/random-array-uniform/tree/esm \ No newline at end of file diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 6ecb862..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,192 +0,0 @@ - -{{alias}}( len, a, b[, options] ) - Returns an array containing pseudorandom numbers drawn from a continuous - uniform distribution. - - Parameters - ---------- - len: integer - Output array length. - - a: number - Minimum support. - - b: number - Maximum support. - - 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) - Output array data type. Default: 'float64'. - - Returns - ------- - out: Array|Float64Array|Float32Array - Output array. - - Examples - -------- - > var out = {{alias}}( 3, 2.0, 5.0 ) - - - -{{alias}}.factory( [a, b, ][options] ) - Returns a function for creating arrays containing pseudorandom numbers drawn - from a continuous uniform distribution. - - If provided `a` and `b`, the returned function returns random variates drawn - from the specified distribution. - - If not provided `a` and `b`, the returned function requires that both `a` - and `b` 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. - - 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 ) - - - // Provide `a` and `b`: - > fcn = {{alias}}.factory( 2.0, 5.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 ) - - - // Get a copy of the current state: - > var state = {{alias}}.state - - - > out = {{alias}}( 3, 2.0, 5.0 ) - - > out = {{alias}}( 3, 2.0, 5.0 ) - - - // Set the state: - > {{alias}}.state = state; - - // Regenerate a previous array: - > out = {{alias}}( 3, 2.0, 5.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 a087b98..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,355 +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. -*/ - -import random = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - random( 10, 2, 3 ); // $ExpectType RandomArray - random( 10, 1, 2 ); // $ExpectType RandomArray - random( 10, 1, 2, {} ); // $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 ); // $ExpectError - random( true, 2.0, 5.0 ); // $ExpectError - random( false, 2.0, 5.0 ); // $ExpectError - random( null, 2.0, 5.0 ); // $ExpectError - random( [], 2.0, 5.0 ); // $ExpectError - random( {}, 2.0, 5.0 ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - random( '5', 2.0, 5.0, {} ); // $ExpectError - random( true, 2.0, 5.0, {} ); // $ExpectError - random( false, 2.0, 5.0, {} ); // $ExpectError - random( null, 2.0, 5.0, {} ); // $ExpectError - random( [], 2.0, 5.0, {} ); // $ExpectError - random( {}, 2.0, 5.0, {} ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.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 ); // $ExpectError - random( 10, true, 5.0 ); // $ExpectError - random( 10, false, 5.0 ); // $ExpectError - random( 10, null, 5.0 ); // $ExpectError - random( 10, [], 5.0 ); // $ExpectError - random( 10, {}, 5.0 ); // $ExpectError - random( 10, ( x: number ): number => x, 5.0 ); // $ExpectError - - random( 10, '5', 5.0, {} ); // $ExpectError - random( 10, true, 5.0, {} ); // $ExpectError - random( 10, false, 5.0, {} ); // $ExpectError - random( 10, null, 5.0, {} ); // $ExpectError - random( 10, [], 5.0, {} ); // $ExpectError - random( 10, {}, 5.0, {} ); // $ExpectError - random( 10, ( x: number ): number => x, 5.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' ); // $ExpectError - random( 10, 2.0, true ); // $ExpectError - random( 10, 2.0, false ); // $ExpectError - random( 10, 2.0, null ); // $ExpectError - random( 10, 2.0, [] ); // $ExpectError - random( 10, 2.0, {} ); // $ExpectError - random( 10, 2.0, ( x: number ): number => x ); // $ExpectError - - random( 10, 2.0, '5', {} ); // $ExpectError - random( 10, 2.0, true, {} ); // $ExpectError - random( 10, 2.0, false, {} ); // $ExpectError - random( 10, 2.0, null, {} ); // $ExpectError - random( 10, 2.0, [], {} ); // $ExpectError - random( 10, 2.0, {}, {} ); // $ExpectError - random( 10, 2.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, '5' ); // $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, [] ); // $ExpectError - random( 10, 2.0, 5.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, { 'dtype': 123 } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': null } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - random( 10, 2.0, 5.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 -} - -// Attached to main export is a `factory` method which returns a function... -{ - random.factory( 2.0, 5.0 ); // $ExpectType UnaryFunction - random.factory( 2.0, 5.0, { 'copy': false } ); // $ExpectType UnaryFunction - - random.factory(); // $ExpectType TernaryFunction - random.factory( { 'copy': false } ); // $ExpectType TernaryFunction -} - -// The `factory` method returns a function which returns an array... -{ - const fcn1 = random.factory( 2.0, 5.0 ); - fcn1( 10 ); // $ExpectType RandomArray - - const fcn2 = random.factory(); - fcn2( 10, 2.0, 5.0 ); // $ExpectType RandomArray -} - -// The compiler throws an error if the `factory` method is provided invalid arguments... -{ - random.factory( '5', 5.0 ); // $ExpectError - random.factory( true, 5.0 ); // $ExpectError - random.factory( false, 5.0 ); // $ExpectError - random.factory( [], 5.0 ); // $ExpectError - random.factory( {}, 5.0 ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0 ); // $ExpectError - - random.factory( '5', 5.0, {} ); // $ExpectError - random.factory( true, 5.0, {} ); // $ExpectError - random.factory( false, 5.0, {} ); // $ExpectError - random.factory( [], 5.0, {} ); // $ExpectError - random.factory( {}, 5.0, {} ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0, {} ); // $ExpectError - - random.factory( 2.0, '5' ); // $ExpectError - random.factory( 2.0, true ); // $ExpectError - random.factory( 2.0, false ); // $ExpectError - random.factory( 2.0, [] ); // $ExpectError - random.factory( 2.0, {} ); // $ExpectError - random.factory( 2.0, ( x: number ): number => x ); // $ExpectError - - random.factory( 2.0, '5', {} ); // $ExpectError - random.factory( 2.0, true, {} ); // $ExpectError - random.factory( 2.0, false, {} ); // $ExpectError - random.factory( 2.0, [], {} ); // $ExpectError - random.factory( 2.0, {}, {} ); // $ExpectError - random.factory( 2.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, 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, { 'prng': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'seed': true } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': [ 'a' ] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'state': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': {} } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': true ); // $ExpectError - random.factory( 2.0, 5.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, { 'copy': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'dtype': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - random.factory( 2.0, 5.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, {}, {} ); // $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 ); - 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 ); // $ExpectError - fcn2( false, 2.0, 5.0 ); // $ExpectError - fcn2( '5', 2.0, 5.0 ); // $ExpectError - fcn2( [], 2.0, 5.0 ); // $ExpectError - fcn2( {}, 2.0, 5.0 ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - fcn2( true, 2.0, 5.0, {} ); // $ExpectError - fcn2( false, 2.0, 5.0, {} ); // $ExpectError - fcn2( '5', 2.0, 5.0, {} ); // $ExpectError - fcn2( [], 2.0, 5.0, {} ); // $ExpectError - fcn2( {}, 2.0, 5.0, {} ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0, {} ); // $ExpectError - - fcn2( 10, true, 5.0 ); // $ExpectError - fcn2( 10, false, 5.0 ); // $ExpectError - fcn2( 10, '5', 5.0 ); // $ExpectError - fcn2( 10, [], 5.0 ); // $ExpectError - fcn2( 10, {}, 5.0 ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0 ); // $ExpectError - - fcn2( 10, true, 5.0, {} ); // $ExpectError - fcn2( 10, false, 5.0, {} ); // $ExpectError - fcn2( 10, '5', 5.0, {} ); // $ExpectError - fcn2( 10, [], 5.0, {} ); // $ExpectError - fcn2( 10, {}, 5.0, {} ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0, {} ); // $ExpectError - - fcn2( 10, 2.0, true ); // $ExpectError - fcn2( 10, 2.0, false ); // $ExpectError - fcn2( 10, 2.0, '5' ); // $ExpectError - fcn2( 10, 2.0, [] ); // $ExpectError - fcn2( 10, 2.0, {} ); // $ExpectError - fcn2( 10, 2.0, ( x: number ): number => x ); // $ExpectError - - fcn2( 10, 2.0, true, {} ); // $ExpectError - fcn2( 10, 2.0, false, {} ); // $ExpectError - fcn2( 10, 2.0, '5', {} ); // $ExpectError - fcn2( 10, 2.0, [], {} ); // $ExpectError - fcn2( 10, 2.0, {}, {} ); // $ExpectError - fcn2( 10, 2.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, { 'dtype': 123 } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': null } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError - - const fcn2 = random.factory( 2.0, 5.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 ); - fcn1(); // $ExpectError - fcn1( 1, 1, 1 ); // $ExpectError - - const fcn2 = random.factory(); - fcn2(); // $ExpectError - fcn2( 1 ); // $ExpectError - fcn2( 1, 1, 1, 1 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index c485546..0000000 --- a/examples/index.js +++ /dev/null @@ -1,48 +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'; - -var logEach = require( '@stdlib/console-log-each' ); -var uniform = require( './../lib' ); - -// Create a function for generating random arrays originating from the same state: -var random = uniform.factory( 2.0, 5.0, { - 'state': uniform.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 = uniform.factory( 2.0, 5.0, { - 'state': uniform.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 458c488..7f0bfdf 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 2.0 -/// +/// import { FloatDataType, 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..a4cb981 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-accessor@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-write-accessor@esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-constant-function@esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-noop@v0.0.14-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/random-base-uniform@esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-typed-real-float-ctors@esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-nullary@esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@esm/index.mjs";import f from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.0.2-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/array-typed-real-float-dtypes@esm/index.mjs";import h from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@esm/index.mjs";var u="float64",c=a();function y(e,t){return h(t)?j(t,"dtype")&&(e.dtype=t.dtype,c.indexOf(e.dtype)<0)?new TypeError(f("null3t","dtype",c.join('", "'),e.dtype)):null:new TypeError(f("null2h",t))}function g(){var a,h,j,c,g,b;if(j={dtype:u},0===(h=arguments.length))g=d,c=x;else if(1===h){if(a=arguments[0],g=d.factory(a),b=y(j,a))throw b;c=x}else if(2===h)g=d.factory(arguments[0],arguments[1]),c=v;else if(3===h){if(a=arguments[2],g=d.factory(arguments[0],arguments[1],a),b=y(j,a))throw b;c=v}return a&&a.prng?(e(c,"seed",null),e(c,"seedLength",null),s(c,"state",r(null),i),e(c,"stateLength",null),e(c,"byteLength",null)):(n(c,"seed",w),n(c,"seedLength",L),s(c,"state",P,R),n(c,"stateLength",G),n(c,"byteLength",N)),e(c,"PRNG",g.PRNG),c;function v(e,n){var s,r,i,d;if(!t(e))throw new TypeError(f("null2p",e));if(d={},arguments.length>1&&(r=y(d,n)))throw r;return"generic"===(i=d.dtype||j.dtype)?l(e,g):(s=new(o(i))(e),m([s],[e],[1],g),s)}function x(e,n,s,r){var i,d,m,a;if(!t(e))throw new TypeError(f("null2p",e));if(a={},arguments.length>3&&(d=y(a,r)))throw d;return"generic"===(m=a.dtype||j.dtype)?l(e,h):(i=new(o(m))(e),p([[n],[s],i],[e],[0,0,1],g),i);function h(){return g(n,s)}}function w(){return c.PRNG.seed}function L(){return c.PRNG.seedLength}function G(){return c.PRNG.stateLength}function N(){return c.PRNG.byteLength}function P(){return c.PRNG.state}function R(e){c.PRNG.state=e}}c.push("generic");var b=g();e(b,"factory",g);export{b as default,g as factory}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..4984bd1 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/factory.js","../lib/main.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 dtypes from '@stdlib/array-typed-real-float-dtypes';\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes();\nDTYPES.push( 'generic' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( 'null2h', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( DTYPES.indexOf( opts.dtype ) < 0 ) {\n\t\t\treturn new TypeError( format( 'null3t', 'dtype', DTYPES.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport setReadOnlyAccessor from '@stdlib/utils-define-nonenumerable-read-only-accessor';\nimport setReadWriteAccessor from '@stdlib/utils-define-nonenumerable-read-write-accessor';\nimport constantFunction from '@stdlib/utils-constant-function';\nimport noop from '@stdlib/utils-noop';\nimport base from '@stdlib/random-base-uniform';\nimport ctors from '@stdlib/array-typed-real-float-ctors';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport nullary from '@stdlib/strided-base-nullary';\nimport binary from '@stdlib/strided-base-binary';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution.\n*\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\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 {RangeError} `a` must be less than `b`\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 uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10 );\n* // returns \n*\n* @example\n* var uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nfunction factory() {\n\tvar options;\n\tvar nargs;\n\tvar opts;\n\tvar rand;\n\tvar prng;\n\tvar err;\n\n\topts = {\n\t\t'dtype': defaults.dtype\n\t};\n\n\tnargs = arguments.length;\n\tif ( nargs === 0 ) {\n\t\tprng = base;\n\t\trand = uniform2;\n\t} else if ( nargs === 1 ) {\n\t\toptions = arguments[ 0 ];\n\t\tprng = base.factory( options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform2;\n\t} else if ( nargs === 2 ) {\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ] );\n\t\trand = uniform1;\n\t} else if ( nargs === 3 ) {\n\t\toptions = arguments[ 2 ];\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ], options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform1;\n\t}\n\tif ( options && options.prng ) {\n\t\tsetReadOnly( rand, 'seed', null );\n\t\tsetReadOnly( rand, 'seedLength', null );\n\t\tsetReadWriteAccessor( rand, 'state', constantFunction( null ), noop );\n\t\tsetReadOnly( rand, 'stateLength', null );\n\t\tsetReadOnly( rand, 'byteLength', null );\n\t} else {\n\t\tsetReadOnlyAccessor( rand, 'seed', getSeed );\n\t\tsetReadOnlyAccessor( rand, 'seedLength', getSeedLength );\n\t\tsetReadWriteAccessor( rand, 'state', getState, setState );\n\t\tsetReadOnlyAccessor( rand, 'stateLength', getStateLength );\n\t\tsetReadOnlyAccessor( rand, 'byteLength', getStateSize );\n\t}\n\tsetReadOnly( rand, 'PRNG', prng.PRNG );\n\treturn rand;\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform1( len, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( 'null2p', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 1 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, prng );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tnullary( [ out ], [ len ], [ 1 ], prng );\n\t\treturn out;\n\t}\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {number} a - minimum support\n\t* @param {number} b - maximum support\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform2( len, a, b, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( 'null2p', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 3 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\t// NOTE: we could alternatively use the PRNG factory function to create a PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. Decision made here to avoid this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom number. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in a return value of `NaN`.\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, wrapper );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tbinary( [ [ a ], [ b ], out ], [ len ], [ 0, 0, 1 ], prng );\n\t\treturn out;\n\n\t\t/**\n\t\t* Applies parameters to a pseudorandom number generator function.\n\t\t*\n\t\t* @private\n\t\t* @returns {number} pseudorandom number\n\t\t*/\n\t\tfunction wrapper() {\n\t\t\treturn prng( a, b );\n\t\t}\n\t}\n\n\t/**\n\t* Returns the PRNG seed.\n\t*\n\t* @private\n\t* @returns {PRNGSeedMT19937} seed\n\t*/\n\tfunction getSeed() {\n\t\treturn rand.PRNG.seed;\n\t}\n\n\t/**\n\t* Returns the PRNG seed length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} seed length\n\t*/\n\tfunction getSeedLength() {\n\t\treturn rand.PRNG.seedLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state length\n\t*/\n\tfunction getStateLength() {\n\t\treturn rand.PRNG.stateLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state size (in bytes).\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state size (in bytes)\n\t*/\n\tfunction getStateSize() {\n\t\treturn rand.PRNG.byteLength;\n\t}\n\n\t/**\n\t* Returns the current pseudorandom number generator state.\n\t*\n\t* @private\n\t* @returns {PRNGStateMT19937} current state\n\t*/\n\tfunction getState() {\n\t\treturn rand.PRNG.state;\n\t}\n\n\t/**\n\t* Sets the pseudorandom number generator state.\n\t*\n\t* @private\n\t* @param {PRNGStateMT19937} s - generator state\n\t* @throws {Error} must provide a valid state\n\t*/\n\tfunction setState( s ) {\n\t\trand.PRNG.state = s;\n\t}\n}\n\n\n// EXPORTS //\n\nexport default factory;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @name uniform\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\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 = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar uniform = factory();\n\n\n// EXPORTS //\n\nexport default uniform;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @module @stdlib/random-array-uniform\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.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\" }\n"],"names":["DTYPES","dtypes","validate","opts","options","isObject","hasOwnProp","dtype","indexOf","TypeError","format","join","factory","nargs","rand","prng","err","defaults","arguments","length","base","uniform2","uniform1","setReadOnly","setReadWriteAccessor","constantFunction","noop","setReadOnlyAccessor","getSeed","getSeedLength","getState","setState","getStateLength","getStateSize","PRNG","len","out","dt","o","isNonNegativeInteger","filledBy","ctors","nullary","a","b","wrapper","binary","seed","seedLength","stateLength","byteLength","state","s","push","uniform","main"],"mappings":";;07CA8BIA,EAASC,IAyBb,SAASC,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,WACzBD,EAAKI,MAAQH,EAAQG,MAChBP,EAAOQ,QAASL,EAAKI,OAAU,GAC5B,IAAIE,UAAWC,EAAQ,SAAU,QAASV,EAAOW,KAAM,QAAUR,EAAKI,QAGxE,KARC,IAAIE,UAAWC,EAAQ,SAAUN,GAS1C,CCSA,SAASQ,IACR,IAAIR,EACAS,EACAV,EACAW,EACAC,EACAC,EAOJ,GALAb,EAAO,CACNI,MAASU,GAIK,KADfJ,EAAQK,UAAUC,QAEjBJ,EAAOK,EACPN,EAAOO,OACD,GAAe,IAAVR,EAAc,CAIzB,GAHAT,EAAUc,UAAW,GACrBH,EAAOK,EAAKR,QAASR,GACrBY,EAAMd,EAAUC,EAAMC,GAErB,MAAMY,EAEPF,EAAOO,CACT,MAAQ,GAAe,IAAVR,EACXE,EAAOK,EAAKR,QAASM,UAAW,GAAKA,UAAW,IAChDJ,EAAOQ,OACD,GAAe,IAAVT,EAAc,CAIzB,GAHAT,EAAUc,UAAW,GACrBH,EAAOK,EAAKR,QAASM,UAAW,GAAKA,UAAW,GAAKd,GACrDY,EAAMd,EAAUC,EAAMC,GAErB,MAAMY,EAEPF,EAAOQ,CACP,CAeD,OAdKlB,GAAWA,EAAQW,MACvBQ,EAAaT,EAAM,OAAQ,MAC3BS,EAAaT,EAAM,aAAc,MACjCU,EAAsBV,EAAM,QAASW,EAAkB,MAAQC,GAC/DH,EAAaT,EAAM,cAAe,MAClCS,EAAaT,EAAM,aAAc,QAEjCa,EAAqBb,EAAM,OAAQc,GACnCD,EAAqBb,EAAM,aAAce,GACzCL,EAAsBV,EAAM,QAASgB,EAAUC,GAC/CJ,EAAqBb,EAAM,cAAekB,GAC1CL,EAAqBb,EAAM,aAAcmB,IAE1CV,EAAaT,EAAM,OAAQC,EAAKmB,MACzBpB,EAcP,SAASQ,EAAUa,EAAK/B,GACvB,IACIgC,EACApB,EACAqB,EACAC,EACJ,IAAMC,EAAsBJ,GAC3B,MAAM,IAAI1B,UAAWC,EAAQ,SAAUyB,IAGxC,GADAG,EAAI,CAAA,EACCpB,UAAUC,OAAS,IACvBH,EAAMd,EAAUoC,EAAGlC,IAElB,MAAMY,EAIR,MAAY,aADZqB,EAAKC,EAAE/B,OAASJ,EAAKI,OAEbiC,EAAUL,EAAKpB,IAGvBqB,EAAM,IADCK,EAAOJ,GACR,CAAUF,GAChBO,EAAS,CAAEN,GAAO,CAAED,GAAO,CAAE,GAAKpB,GAC3BqB,EACP,CAgBD,SAASf,EAAUc,EAAKQ,EAAGC,EAAGxC,GAC7B,IACIgC,EACApB,EACAqB,EACAC,EACJ,IAAMC,EAAsBJ,GAC3B,MAAM,IAAI1B,UAAWC,EAAQ,SAAUyB,IAGxC,GADAG,EAAI,CAAA,EACCpB,UAAUC,OAAS,IACvBH,EAAMd,EAAUoC,EAAGlC,IAElB,MAAMY,EAKR,MAAY,aADZqB,EAAKC,EAAE/B,OAASJ,EAAKI,OAEbiC,EAAUL,EAAKU,IAGvBT,EAAM,IADCK,EAAOJ,GACR,CAAUF,GAChBW,EAAQ,CAAE,CAAEH,GAAK,CAAEC,GAAKR,GAAO,CAAED,GAAO,CAAE,EAAG,EAAG,GAAKpB,GAC9CqB,GAQP,SAASS,IACR,OAAO9B,EAAM4B,EAAGC,EAChB,CACD,CAQD,SAAShB,IACR,OAAOd,EAAKoB,KAAKa,IACjB,CAQD,SAASlB,IACR,OAAOf,EAAKoB,KAAKc,UACjB,CAQD,SAAShB,IACR,OAAOlB,EAAKoB,KAAKe,WACjB,CAQD,SAAShB,IACR,OAAOnB,EAAKoB,KAAKgB,UACjB,CAQD,SAASpB,IACR,OAAOhB,EAAKoB,KAAKiB,KACjB,CASD,SAASpB,EAAUqB,GAClBtC,EAAKoB,KAAKiB,MAAQC,CAClB,CACF,CDrPApD,EAAOqD,KAAM,WEqBV,IAACC,EAAU1C,ICiBdW,EAAAgC,EAAA,UAAA3C"} \ No newline at end of file diff --git a/lib/defaults.json b/lib/defaults.json deleted file mode 100644 index 83f4438..0000000 --- a/lib/defaults.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "dtype": "float64" -} diff --git a/lib/factory.js b/lib/factory.js deleted file mode 100644 index 9f232af..0000000 --- a/lib/factory.js +++ /dev/null @@ -1,282 +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 isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var setReadOnlyAccessor = require( '@stdlib/utils-define-nonenumerable-read-only-accessor' ); -var setReadWriteAccessor = require( '@stdlib/utils-define-nonenumerable-read-write-accessor' ); -var constantFunction = require( '@stdlib/utils-constant-function' ); -var noop = require( '@stdlib/utils-noop' ); -var base = require( '@stdlib/random-base-uniform' ); -var ctors = require( '@stdlib/array-typed-real-float-ctors' ); -var filledBy = require( '@stdlib/array-base-filled-by' ); -var nullary = require( '@stdlib/strided-base-nullary' ); -var binary = require( '@stdlib/strided-base-binary' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution. -* -* @param {number} [a] - minimum support -* @param {number} [b] - maximum support -* @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 {RangeError} `a` must be less than `b` -* @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 uniform = factory( 2.0, 5.0 ); -* // returns -* -* var arr = uniform( 10 ); -* // returns -* -* @example -* var uniform = factory( 2.0, 5.0 ); -* // returns -* -* var arr = uniform( 10, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -function factory() { - var options; - var nargs; - var opts; - var rand; - var prng; - var err; - - opts = { - 'dtype': defaults.dtype - }; - - nargs = arguments.length; - if ( nargs === 0 ) { - prng = base; - rand = uniform2; - } else if ( nargs === 1 ) { - options = arguments[ 0 ]; - prng = base.factory( options ); - err = validate( opts, options ); - if ( err ) { - throw err; - } - rand = uniform2; - } else if ( nargs === 2 ) { - prng = base.factory( arguments[ 0 ], arguments[ 1 ] ); - rand = uniform1; - } else if ( nargs === 3 ) { - options = arguments[ 2 ]; - prng = base.factory( arguments[ 0 ], arguments[ 1 ], options ); - err = validate( opts, options ); - if ( err ) { - throw err; - } - rand = uniform1; - } - if ( options && options.prng ) { - setReadOnly( rand, 'seed', null ); - setReadOnly( rand, 'seedLength', null ); - setReadWriteAccessor( rand, 'state', constantFunction( null ), noop ); - setReadOnly( rand, 'stateLength', null ); - setReadOnly( rand, 'byteLength', null ); - } else { - setReadOnlyAccessor( rand, 'seed', getSeed ); - setReadOnlyAccessor( rand, 'seedLength', getSeedLength ); - setReadWriteAccessor( rand, 'state', getState, setState ); - setReadOnlyAccessor( rand, 'stateLength', getStateLength ); - setReadOnlyAccessor( rand, 'byteLength', getStateSize ); - } - setReadOnly( rand, 'PRNG', prng.PRNG ); - return rand; - - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @private - * @param {NonNegativeInteger} len - array length - * @param {Options} [options] - function options - * @param {string} [options.dtype] - 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 - */ - function uniform1( len, options ) { - var ctor; - var out; - var err; - var dt; - var o; - if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( 'null2p', len ) ); - } - o = {}; - if ( arguments.length > 1 ) { - err = validate( o, options ); - if ( err ) { - throw err; - } - } - dt = o.dtype || opts.dtype; - if ( dt === 'generic' ) { - return filledBy( len, prng ); - } - ctor = ctors( dt ); - out = new ctor( len ); - nullary( [ out ], [ len ], [ 1 ], prng ); - return out; - } - - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @private - * @param {NonNegativeInteger} len - array length - * @param {number} a - minimum support - * @param {number} b - maximum support - * @param {Options} [options] - function options - * @param {string} [options.dtype] - 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 - */ - function uniform2( len, a, b, options ) { - var ctor; - var out; - var err; - var dt; - var o; - if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( 'null2p', len ) ); - } - o = {}; - if ( arguments.length > 3 ) { - err = validate( o, options ); - if ( err ) { - throw err; - } - } - // NOTE: we could alternatively use the PRNG factory function to create a PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. Decision made here to avoid this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom number. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in a return value of `NaN`. - dt = o.dtype || opts.dtype; - if ( dt === 'generic' ) { - return filledBy( len, wrapper ); - } - ctor = ctors( dt ); - out = new ctor( len ); - binary( [ [ a ], [ b ], out ], [ len ], [ 0, 0, 1 ], prng ); - return out; - - /** - * Applies parameters to a pseudorandom number generator function. - * - * @private - * @returns {number} pseudorandom number - */ - function wrapper() { - return prng( a, b ); - } - } - - /** - * Returns the PRNG seed. - * - * @private - * @returns {PRNGSeedMT19937} seed - */ - function getSeed() { - return rand.PRNG.seed; - } - - /** - * Returns the PRNG seed length. - * - * @private - * @returns {PositiveInteger} seed length - */ - function getSeedLength() { - return rand.PRNG.seedLength; - } - - /** - * Returns the PRNG state length. - * - * @private - * @returns {PositiveInteger} state length - */ - function getStateLength() { - return rand.PRNG.stateLength; - } - - /** - * Returns the PRNG state size (in bytes). - * - * @private - * @returns {PositiveInteger} state size (in bytes) - */ - function getStateSize() { - return rand.PRNG.byteLength; - } - - /** - * Returns the current pseudorandom number generator state. - * - * @private - * @returns {PRNGStateMT19937} current state - */ - function getState() { - return rand.PRNG.state; - } - - /** - * Sets the pseudorandom number generator state. - * - * @private - * @param {PRNGStateMT19937} s - generator state - * @throws {Error} must provide a valid state - */ - function setState( s ) { - rand.PRNG.state = s; - } -} - - -// EXPORTS // - -module.exports = factory; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 0077f00..0000000 --- a/lib/index.js +++ /dev/null @@ -1,77 +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'; - -/** -* Create an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. -* -* @module @stdlib/random-array-uniform -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var arr = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var arr = uniform( 10, 2.0, 5.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var rand = uniform.factory( 2.0, 5.0 ); -* // returns -* -* var arr = rand( 10 ); -* // returns -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var rand = uniform.factory( 2.0, 5.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" } diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index da0d9b1..0000000 --- a/lib/main.js +++ /dev/null @@ -1,58 +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 factory = require( './factory.js' ); - - -// MAIN // - -/** -* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. -* -* @name uniform -* @type {Function} -* @param {NonNegativeInteger} len - array length -* @param {number} a - minimum support -* @param {number} b - maximum support -* @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 = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var arr = uniform( 10, 2.0, 5.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -var uniform = factory(); - - -// EXPORTS // - -module.exports = uniform; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index 3629aaf..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,72 +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 dtypes = require( '@stdlib/array-typed-real-float-dtypes' ); -var isObject = require( '@stdlib/assert-is-plain-object' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// VARIABLES // - -var DTYPES = dtypes(); -DTYPES.push( 'generic' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Options} options - function options -* @param {string} [options.dtype] - output array data type -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var options = { -* 'dtype': 'float64' -* }; -* var err = validate( opts, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( 'null2h', options ) ); - } - if ( hasOwnProp( options, 'dtype' ) ) { - opts.dtype = options.dtype; - if ( DTYPES.indexOf( opts.dtype ) < 0 ) { - return new TypeError( format( 'null3t', 'dtype', DTYPES.join( '", "' ), opts.dtype ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index 8b6d28d..621da6a 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 continuous uniform 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,55 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-filled-by": "^0.0.2", - "@stdlib/array-typed-real-float-ctors": "^0.0.1", - "@stdlib/array-typed-real-float-dtypes": "^0.0.1", - "@stdlib/assert-has-own-property": "^0.0.7", - "@stdlib/assert-is-nonnegative-integer": "^0.0.7", - "@stdlib/assert-is-plain-object": "^0.0.7", - "@stdlib/random-base-uniform": "^0.0.6", - "@stdlib/strided-base-binary": "^0.0.8", - "@stdlib/strided-base-nullary": "^0.0.7", - "@stdlib/error-tools-fmtprodmsg": "^0.0.2", - "@stdlib/types": "^0.0.14", - "@stdlib/utils-constant-function": "^0.0.8", - "@stdlib/utils-define-nonenumerable-read-only-accessor": "^0.0.7", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.7", - "@stdlib/utils-define-nonenumerable-read-write-accessor": "^0.0.7", - "@stdlib/utils-noop": "^0.0.14" - }, - "devDependencies": { - "@stdlib/array-float32": "^0.0.6", - "@stdlib/array-float64": "^0.0.6", - "@stdlib/array-uint32": "^0.0.6", - "@stdlib/assert-is-uint32array": "^0.0.8", - "@stdlib/bench": "^0.0.12", - "@stdlib/console-log-each": "^0.0.2", - "@stdlib/constants-uint32-max": "^0.0.7", - "@stdlib/math-base-assert-is-nan": "^0.0.8", - "@stdlib/math-base-assert-is-nanf": "^0.0.8", - "@stdlib/math-base-special-pow": "^0.0.7", - "@stdlib/random-base-minstd": "^0.0.6", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdmath", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..87c587a --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/test.factory.js b/test/test.factory.js deleted file mode 100644 index a869e75..0000000 --- a/test/test.factory.js +++ /dev/null @@ -1,1328 +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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -tape( 'the function throws an error if the second distribution parameter is less than the first distribution parameter', function test( t ) { - var values; - var i; - - values = [ - [ 0.0, 0.0 ], - [ -2.0, -4.0 ], - [ 2.0, 1.0 ] - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( arr ) { - return function badValue() { - factory( arr[0], arr[1] ); - }; - } -}); - -tape( 'the function throws an error if the second distribution parameter is less than the first distribution parameter (options)', function test( t ) { - var values; - var i; - - values = [ - [ 0.0, 0.0 ], - [ -2.0, -4.0 ], - [ 2.0, 1.0 ] - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( arr ) { - return function badValue() { - factory( arr[0], arr[1], {} ); - }; - } -}); - -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, 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, { - '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, { - '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, { - '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, { - '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, { - '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, { - '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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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 ); - - 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 ); - - 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, { - '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 ); - - 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 ); - 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( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory(); - actual = random( 10, 2.0, 5.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( typeof actual[ i ], 'number', '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 ); - - 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 ); - - 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 ); - - 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 that generates `NaN` values if the first distribution parameter is greater than or equal to the second distribution parameter', function test( t ) { - var random; - var values; - var actual; - var i; - var j; - - random = factory(); - values = [ - [ 2.0, 1.0 ], - [ -3.0, -4.0 ], - [ 0.0, 0.0 ] - ]; - - for ( i = 0; i < values.length; i++ ) { - actual = random( 10, values[ i ][ 0 ], values[ i ][ 1 ] ); - for ( j = 0; j < actual.length; j++ ) { - t.strictEqual( isnan( actual[ j ] ), true, 'returns expected value when provided '+values[ 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, { - '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 ); - - 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, { - '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( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'float64' - }); - actual = random( 10, 2.0, 5.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( typeof actual[ i ], 'number', '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, { - '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( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'float32' - }); - actual = random( 10, 2.0, 5.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( typeof actual[ i ], 'number', '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, { - '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 ); - - 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, { - '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, { - '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 ); - - // 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, { - '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 ); - - // 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, { - '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 ); - - 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, { - 'prng': randu.normalized - }); - - randu = minstd.factory({ - 'seed': seed - }); - random2 = factory( 2.0, 5.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 ); - arr2 = random2( 10, 2.0, 5.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 c4fb6d3..0000000 --- a/test/test.js +++ /dev/null @@ -1,69 +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 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 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 37b0080..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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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, 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, { - '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 ); - - 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( typeof actual[ i ], 'number', '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, { - '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( typeof actual[ i ], 'number', '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, { - '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( typeof actual[ i ], 'number', '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, { - '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 ); - } - // Capture the current state: - state = random.state; - - // Move to a future state... - arr = random( 10, 2.0, 5.0 ); - for ( i = 0; i < 100; i++ ) { - random( 2, 2.0, 5.0 ); - } - // Set the state: - random.state = state; - - // Replay previously generated values: - t.deepEqual( random( 10, 2.0, 5.0 ), arr, 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.validate.js b/test/test.validate.js deleted file mode 100644 index c515526..0000000 --- a/test/test.validate.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 validate = require( './../lib/validate.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.equal( typeof validate, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function returns an error if provided an options argument which is not an object', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - void 0, - null, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, values[ i ] ); - t.equal( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided a `dtype` option which is not a supported data type', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - -5, - NaN, - true, - false, - void 0, - null, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, { - 'dtype': values[ i ] - }); - t.equal( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns null if all options are valid', function test( t ) { - var options; - var opts; - var err; - - options = { - 'dtype': 'float64' - }; - opts = {}; - err = validate( opts, options ); - - t.equal( err, null, 'returns null' ); - t.deepEqual( opts, options, 'sets option values' ); - - t.end(); -}); - -tape( 'the function ignores unrecognized/unsupported options', function test( t ) { - var options; - var opts; - var err; - - options = { - 'beep': true, - 'boop': 'bop' - }; - opts = {}; - err = validate( opts, options ); - - t.equal( err, null, 'returns null' ); - t.deepEqual( opts, {}, 'does not set any option values' ); - t.end(); -}); From 58e6a1aa44b31a0eb7a8fcc478d9c8cfcfce6d11 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 12 Feb 2023 02:19:21 +0000 Subject: [PATCH 12/82] Transform error messages --- lib/factory.js | 6 +++--- lib/validate.js | 6 +++--- package.json | 2 +- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/lib/factory.js b/lib/factory.js index 22ec236..9f232af 100644 --- a/lib/factory.js +++ b/lib/factory.js @@ -31,7 +31,7 @@ var ctors = require( '@stdlib/array-typed-real-float-ctors' ); var filledBy = require( '@stdlib/array-base-filled-by' ); var nullary = require( '@stdlib/strided-base-nullary' ); var binary = require( '@stdlib/strided-base-binary' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -144,7 +144,7 @@ function factory() { var dt; var o; if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) ); + throw new TypeError( format( 'null2p', len ) ); } o = {}; if ( arguments.length > 1 ) { @@ -184,7 +184,7 @@ function factory() { var dt; var o; if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) ); + throw new TypeError( format( 'null2p', len ) ); } o = {}; if ( arguments.length > 3 ) { diff --git a/lib/validate.js b/lib/validate.js index 40b9723..3629aaf 100644 --- a/lib/validate.js +++ b/lib/validate.js @@ -23,7 +23,7 @@ var dtypes = require( '@stdlib/array-typed-real-float-dtypes' ); var isObject = require( '@stdlib/assert-is-plain-object' ); var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // VARIABLES // @@ -55,12 +55,12 @@ DTYPES.push( 'generic' ); */ function validate( opts, options ) { if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); + return new TypeError( format( 'null2h', options ) ); } if ( hasOwnProp( options, 'dtype' ) ) { opts.dtype = options.dtype; if ( DTYPES.indexOf( opts.dtype ) < 0 ) { - return new TypeError( format( 'invalid option. `%s` option must be one of the following: "%s". Option: `%s`.', 'dtype', DTYPES.join( '", "' ), opts.dtype ) ); + return new TypeError( format( 'null3t', 'dtype', DTYPES.join( '", "' ), opts.dtype ) ); } } return null; diff --git a/package.json b/package.json index 486f4d2..8b6d28d 100644 --- a/package.json +++ b/package.json @@ -46,7 +46,7 @@ "@stdlib/random-base-uniform": "^0.0.6", "@stdlib/strided-base-binary": "^0.0.8", "@stdlib/strided-base-nullary": "^0.0.7", - "@stdlib/string-format": "^0.0.3", + "@stdlib/error-tools-fmtprodmsg": "^0.0.2", "@stdlib/types": "^0.0.14", "@stdlib/utils-constant-function": "^0.0.8", "@stdlib/utils-define-nonenumerable-read-only-accessor": "^0.0.7", From 01d492cc1ac8ec05afa7e573146a12aa74a47f1e Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 12 Feb 2023 02:23:06 +0000 Subject: [PATCH 13/82] Remove files --- index.d.ts | 245 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6427 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 7f0bfdf..0000000 --- a/index.d.ts +++ /dev/null @@ -1,245 +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. -*/ - -// TypeScript Version: 2.0 - -/// - -import { FloatDataType, FloatTypedArray } from '@stdlib/types/array'; -import * as random from '@stdlib/types/random'; - -/** -* Supported data types. -*/ -type DataType = FloatDataType | 'generic'; - -/** -* 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 { - /** - * Default output array data type. Default: 'float64'. - */ - 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 continuous uniform distribution with pre-specified parameter values. -*/ -interface UnaryFunction extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @param len - array length - * @param options - function options - * @returns output array - */ - ( len: number, options?: Options ): RandomArray; -} - -/** -* Interface for generating pseudorandom numbers drawn from a continuous uniform distribution without pre-specified parameter values. -*/ -interface TernaryFunction extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @param len - array length - * @param a - minimum support - * @param b - maximum support - * @param options - function options - * @returns output array - */ - ( len: number, a: number, b: number, options?: Options ): RandomArray; -} - -/** -* Interface for generating pseudorandom numbers drawn from a uniform distribution. -*/ -interface Random extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @param len - array length - * @param a - minimum support - * @param b - maximum support - * @param options - function options - * @returns output array - * - * @example - * var out = uniform( 10, 2.0, 5.0 ); - * // returns - */ - ( len: number, a: number, b: number, options?: Options ): RandomArray; - - /** - * Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution. - * - * ## Notes - * - * - When provided `a` and `b`, the returned function returns random variates drawn from the specified distribution. - * - * @param a - minimum support - * @param b - maximum support - * @param options - function options - * @throws `a` must be less than `b` - * @throws must provide a valid state - * @returns function for creating arrays - * - * @example - * var random = uniform.factory( 2.0, 5.0 ); - * - * var out = random( 10 ); - * // returns - * - * @example - * var random = uniform.factory( 2.0, 5.0, { - * 'seed': 297 - * }); - * var out = random( 10 ); - * // returns - */ - factory( a: number, b: number, options?: FactoryOptions ): UnaryFunction; - - /** - * Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution. - * - * ## Notes - * - * - When not provided `a` and `b`, the returned function requires that both `a` and `b` be provided at each invocation. - * - * @param options - function options - * @throws must provide a valid state - * @returns function for creating arrays - * - * @example - * var random = uniform.factory(); - * - * var out = random( 10, 2.0, 5.0 ); - * // returns - * - * @example - * var random = uniform.factory({ - * 'seed': 297 - * }); - * var out = random( 10, 2.0, 5.0 ); - * // returns - */ - factory( options?: FactoryOptions ): TernaryFunction; -} - -/** -* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. -* -* @param len - array length -* @param a - minimum support -* @param b - maximum support -* @param options - function options -* @returns output array -* -* @example -* var out = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var random = uniform.factory( 2.0, 5.0 ); -* -* var out = random( 10 ); -* // returns -*/ -declare var uniform: Random; - - -// EXPORTS // - -export = uniform; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index a4cb981..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-accessor@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-write-accessor@esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-constant-function@esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-noop@v0.0.14-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/random-base-uniform@esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-typed-real-float-ctors@esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-nullary@esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@esm/index.mjs";import f from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.0.2-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/array-typed-real-float-dtypes@esm/index.mjs";import h from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@esm/index.mjs";var u="float64",c=a();function y(e,t){return h(t)?j(t,"dtype")&&(e.dtype=t.dtype,c.indexOf(e.dtype)<0)?new TypeError(f("null3t","dtype",c.join('", "'),e.dtype)):null:new TypeError(f("null2h",t))}function g(){var a,h,j,c,g,b;if(j={dtype:u},0===(h=arguments.length))g=d,c=x;else if(1===h){if(a=arguments[0],g=d.factory(a),b=y(j,a))throw b;c=x}else if(2===h)g=d.factory(arguments[0],arguments[1]),c=v;else if(3===h){if(a=arguments[2],g=d.factory(arguments[0],arguments[1],a),b=y(j,a))throw b;c=v}return a&&a.prng?(e(c,"seed",null),e(c,"seedLength",null),s(c,"state",r(null),i),e(c,"stateLength",null),e(c,"byteLength",null)):(n(c,"seed",w),n(c,"seedLength",L),s(c,"state",P,R),n(c,"stateLength",G),n(c,"byteLength",N)),e(c,"PRNG",g.PRNG),c;function v(e,n){var s,r,i,d;if(!t(e))throw new TypeError(f("null2p",e));if(d={},arguments.length>1&&(r=y(d,n)))throw r;return"generic"===(i=d.dtype||j.dtype)?l(e,g):(s=new(o(i))(e),m([s],[e],[1],g),s)}function x(e,n,s,r){var i,d,m,a;if(!t(e))throw new TypeError(f("null2p",e));if(a={},arguments.length>3&&(d=y(a,r)))throw d;return"generic"===(m=a.dtype||j.dtype)?l(e,h):(i=new(o(m))(e),p([[n],[s],i],[e],[0,0,1],g),i);function h(){return g(n,s)}}function w(){return c.PRNG.seed}function L(){return c.PRNG.seedLength}function G(){return c.PRNG.stateLength}function N(){return c.PRNG.byteLength}function P(){return c.PRNG.state}function R(e){c.PRNG.state=e}}c.push("generic");var b=g();e(b,"factory",g);export{b as default,g as factory}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 4984bd1..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/factory.js","../lib/main.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 dtypes from '@stdlib/array-typed-real-float-dtypes';\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes();\nDTYPES.push( 'generic' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( 'null2h', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( DTYPES.indexOf( opts.dtype ) < 0 ) {\n\t\t\treturn new TypeError( format( 'null3t', 'dtype', DTYPES.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport setReadOnlyAccessor from '@stdlib/utils-define-nonenumerable-read-only-accessor';\nimport setReadWriteAccessor from '@stdlib/utils-define-nonenumerable-read-write-accessor';\nimport constantFunction from '@stdlib/utils-constant-function';\nimport noop from '@stdlib/utils-noop';\nimport base from '@stdlib/random-base-uniform';\nimport ctors from '@stdlib/array-typed-real-float-ctors';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport nullary from '@stdlib/strided-base-nullary';\nimport binary from '@stdlib/strided-base-binary';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution.\n*\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\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 {RangeError} `a` must be less than `b`\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 uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10 );\n* // returns \n*\n* @example\n* var uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nfunction factory() {\n\tvar options;\n\tvar nargs;\n\tvar opts;\n\tvar rand;\n\tvar prng;\n\tvar err;\n\n\topts = {\n\t\t'dtype': defaults.dtype\n\t};\n\n\tnargs = arguments.length;\n\tif ( nargs === 0 ) {\n\t\tprng = base;\n\t\trand = uniform2;\n\t} else if ( nargs === 1 ) {\n\t\toptions = arguments[ 0 ];\n\t\tprng = base.factory( options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform2;\n\t} else if ( nargs === 2 ) {\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ] );\n\t\trand = uniform1;\n\t} else if ( nargs === 3 ) {\n\t\toptions = arguments[ 2 ];\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ], options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform1;\n\t}\n\tif ( options && options.prng ) {\n\t\tsetReadOnly( rand, 'seed', null );\n\t\tsetReadOnly( rand, 'seedLength', null );\n\t\tsetReadWriteAccessor( rand, 'state', constantFunction( null ), noop );\n\t\tsetReadOnly( rand, 'stateLength', null );\n\t\tsetReadOnly( rand, 'byteLength', null );\n\t} else {\n\t\tsetReadOnlyAccessor( rand, 'seed', getSeed );\n\t\tsetReadOnlyAccessor( rand, 'seedLength', getSeedLength );\n\t\tsetReadWriteAccessor( rand, 'state', getState, setState );\n\t\tsetReadOnlyAccessor( rand, 'stateLength', getStateLength );\n\t\tsetReadOnlyAccessor( rand, 'byteLength', getStateSize );\n\t}\n\tsetReadOnly( rand, 'PRNG', prng.PRNG );\n\treturn rand;\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform1( len, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( 'null2p', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 1 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, prng );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tnullary( [ out ], [ len ], [ 1 ], prng );\n\t\treturn out;\n\t}\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {number} a - minimum support\n\t* @param {number} b - maximum support\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform2( len, a, b, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( 'null2p', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 3 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\t// NOTE: we could alternatively use the PRNG factory function to create a PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. Decision made here to avoid this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom number. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in a return value of `NaN`.\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, wrapper );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tbinary( [ [ a ], [ b ], out ], [ len ], [ 0, 0, 1 ], prng );\n\t\treturn out;\n\n\t\t/**\n\t\t* Applies parameters to a pseudorandom number generator function.\n\t\t*\n\t\t* @private\n\t\t* @returns {number} pseudorandom number\n\t\t*/\n\t\tfunction wrapper() {\n\t\t\treturn prng( a, b );\n\t\t}\n\t}\n\n\t/**\n\t* Returns the PRNG seed.\n\t*\n\t* @private\n\t* @returns {PRNGSeedMT19937} seed\n\t*/\n\tfunction getSeed() {\n\t\treturn rand.PRNG.seed;\n\t}\n\n\t/**\n\t* Returns the PRNG seed length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} seed length\n\t*/\n\tfunction getSeedLength() {\n\t\treturn rand.PRNG.seedLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state length\n\t*/\n\tfunction getStateLength() {\n\t\treturn rand.PRNG.stateLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state size (in bytes).\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state size (in bytes)\n\t*/\n\tfunction getStateSize() {\n\t\treturn rand.PRNG.byteLength;\n\t}\n\n\t/**\n\t* Returns the current pseudorandom number generator state.\n\t*\n\t* @private\n\t* @returns {PRNGStateMT19937} current state\n\t*/\n\tfunction getState() {\n\t\treturn rand.PRNG.state;\n\t}\n\n\t/**\n\t* Sets the pseudorandom number generator state.\n\t*\n\t* @private\n\t* @param {PRNGStateMT19937} s - generator state\n\t* @throws {Error} must provide a valid state\n\t*/\n\tfunction setState( s ) {\n\t\trand.PRNG.state = s;\n\t}\n}\n\n\n// EXPORTS //\n\nexport default factory;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @name uniform\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\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 = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar uniform = factory();\n\n\n// EXPORTS //\n\nexport default uniform;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @module @stdlib/random-array-uniform\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.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\" }\n"],"names":["DTYPES","dtypes","validate","opts","options","isObject","hasOwnProp","dtype","indexOf","TypeError","format","join","factory","nargs","rand","prng","err","defaults","arguments","length","base","uniform2","uniform1","setReadOnly","setReadWriteAccessor","constantFunction","noop","setReadOnlyAccessor","getSeed","getSeedLength","getState","setState","getStateLength","getStateSize","PRNG","len","out","dt","o","isNonNegativeInteger","filledBy","ctors","nullary","a","b","wrapper","binary","seed","seedLength","stateLength","byteLength","state","s","push","uniform","main"],"mappings":";;07CA8BIA,EAASC,IAyBb,SAASC,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,WACzBD,EAAKI,MAAQH,EAAQG,MAChBP,EAAOQ,QAASL,EAAKI,OAAU,GAC5B,IAAIE,UAAWC,EAAQ,SAAU,QAASV,EAAOW,KAAM,QAAUR,EAAKI,QAGxE,KARC,IAAIE,UAAWC,EAAQ,SAAUN,GAS1C,CCSA,SAASQ,IACR,IAAIR,EACAS,EACAV,EACAW,EACAC,EACAC,EAOJ,GALAb,EAAO,CACNI,MAASU,GAIK,KADfJ,EAAQK,UAAUC,QAEjBJ,EAAOK,EACPN,EAAOO,OACD,GAAe,IAAVR,EAAc,CAIzB,GAHAT,EAAUc,UAAW,GACrBH,EAAOK,EAAKR,QAASR,GACrBY,EAAMd,EAAUC,EAAMC,GAErB,MAAMY,EAEPF,EAAOO,CACT,MAAQ,GAAe,IAAVR,EACXE,EAAOK,EAAKR,QAASM,UAAW,GAAKA,UAAW,IAChDJ,EAAOQ,OACD,GAAe,IAAVT,EAAc,CAIzB,GAHAT,EAAUc,UAAW,GACrBH,EAAOK,EAAKR,QAASM,UAAW,GAAKA,UAAW,GAAKd,GACrDY,EAAMd,EAAUC,EAAMC,GAErB,MAAMY,EAEPF,EAAOQ,CACP,CAeD,OAdKlB,GAAWA,EAAQW,MACvBQ,EAAaT,EAAM,OAAQ,MAC3BS,EAAaT,EAAM,aAAc,MACjCU,EAAsBV,EAAM,QAASW,EAAkB,MAAQC,GAC/DH,EAAaT,EAAM,cAAe,MAClCS,EAAaT,EAAM,aAAc,QAEjCa,EAAqBb,EAAM,OAAQc,GACnCD,EAAqBb,EAAM,aAAce,GACzCL,EAAsBV,EAAM,QAASgB,EAAUC,GAC/CJ,EAAqBb,EAAM,cAAekB,GAC1CL,EAAqBb,EAAM,aAAcmB,IAE1CV,EAAaT,EAAM,OAAQC,EAAKmB,MACzBpB,EAcP,SAASQ,EAAUa,EAAK/B,GACvB,IACIgC,EACApB,EACAqB,EACAC,EACJ,IAAMC,EAAsBJ,GAC3B,MAAM,IAAI1B,UAAWC,EAAQ,SAAUyB,IAGxC,GADAG,EAAI,CAAA,EACCpB,UAAUC,OAAS,IACvBH,EAAMd,EAAUoC,EAAGlC,IAElB,MAAMY,EAIR,MAAY,aADZqB,EAAKC,EAAE/B,OAASJ,EAAKI,OAEbiC,EAAUL,EAAKpB,IAGvBqB,EAAM,IADCK,EAAOJ,GACR,CAAUF,GAChBO,EAAS,CAAEN,GAAO,CAAED,GAAO,CAAE,GAAKpB,GAC3BqB,EACP,CAgBD,SAASf,EAAUc,EAAKQ,EAAGC,EAAGxC,GAC7B,IACIgC,EACApB,EACAqB,EACAC,EACJ,IAAMC,EAAsBJ,GAC3B,MAAM,IAAI1B,UAAWC,EAAQ,SAAUyB,IAGxC,GADAG,EAAI,CAAA,EACCpB,UAAUC,OAAS,IACvBH,EAAMd,EAAUoC,EAAGlC,IAElB,MAAMY,EAKR,MAAY,aADZqB,EAAKC,EAAE/B,OAASJ,EAAKI,OAEbiC,EAAUL,EAAKU,IAGvBT,EAAM,IADCK,EAAOJ,GACR,CAAUF,GAChBW,EAAQ,CAAE,CAAEH,GAAK,CAAEC,GAAKR,GAAO,CAAED,GAAO,CAAE,EAAG,EAAG,GAAKpB,GAC9CqB,GAQP,SAASS,IACR,OAAO9B,EAAM4B,EAAGC,EAChB,CACD,CAQD,SAAShB,IACR,OAAOd,EAAKoB,KAAKa,IACjB,CAQD,SAASlB,IACR,OAAOf,EAAKoB,KAAKc,UACjB,CAQD,SAAShB,IACR,OAAOlB,EAAKoB,KAAKe,WACjB,CAQD,SAAShB,IACR,OAAOnB,EAAKoB,KAAKgB,UACjB,CAQD,SAASpB,IACR,OAAOhB,EAAKoB,KAAKiB,KACjB,CASD,SAASpB,EAAUqB,GAClBtC,EAAKoB,KAAKiB,MAAQC,CAClB,CACF,CDrPApD,EAAOqD,KAAM,WEqBV,IAACC,EAAU1C,ICiBdW,EAAAgC,EAAA,UAAA3C"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 87c587a..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 9adc3fb2538eefb8196b5316940f1c33bb712ce5 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 12 Feb 2023 02:24:03 +0000 Subject: [PATCH 14/82] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 62 - .github/workflows/cancel.yml | 56 - .github/workflows/close_pull_requests.yml | 44 - .github/workflows/examples.yml | 62 - .github/workflows/npm_downloads.yml | 108 - .github/workflows/productionize.yml | 798 --- .github/workflows/publish.yml | 236 - .github/workflows/test.yml | 97 - .github/workflows/test_bundles.yml | 180 - .github/workflows/test_coverage.yml | 123 - .github/workflows/test_install.yml | 83 - .gitignore | 184 - .npmignore | 227 - .npmrc | 28 - CHANGELOG.md | 5 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 61 +- benchmark/benchmark.float32.factory.js | 96 - benchmark/benchmark.float32.js | 98 - benchmark/benchmark.float64.factory.js | 96 - benchmark/benchmark.float64.js | 98 - benchmark/benchmark.generic.factory.js | 96 - benchmark/benchmark.generic.js | 98 - branches.md | 53 - docs/repl.txt | 192 - docs/types/test.ts | 355 -- examples/index.js | 48 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/defaults.json | 3 - lib/factory.js | 282 - lib/index.js | 77 - lib/main.js | 58 - lib/validate.js | 72 - package.json | 76 +- stats.html | 6177 +++++++++++++++++++++ test/test.factory.js | 1328 ----- test/test.js | 69 - test/test.main.js | 244 - test/test.validate.js | 118 - 47 files changed, 6215 insertions(+), 6658 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 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 benchmark/benchmark.float32.factory.js delete mode 100644 benchmark/benchmark.float32.js delete mode 100644 benchmark/benchmark.float64.factory.js delete mode 100644 benchmark/benchmark.float64.js delete mode 100644 benchmark/benchmark.generic.factory.js delete mode 100644 benchmark/benchmark.generic.js delete mode 100644 branches.md 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/defaults.json delete mode 100644 lib/factory.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/test.factory.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js delete mode 100644 test/test.validate.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 0fd4d6c..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 `tslint.json` files: -[tslint.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 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 c4ab52b..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/uniform) 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 06a9a75..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,62 +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' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 a00dbe5..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,56 +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' - uses: styfle/cancel-workflow-action@0.11.0 - 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 7eca213..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,44 +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: - run: - runs-on: ubuntu-latest - steps: - - uses: superbrothers/close-pull-request@v3 - 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/uniform) 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 7902a7d..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,62 +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 the repository: - - name: 'Checkout the repository' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 818b9df..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,108 +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: '33 9 * * 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' - uses: actions/checkout@v3 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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' - uses: actions/upload-artifact@v3 - 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' - uses: distributhor/workflow-webhook@v3 - 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 3e8e2db..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,798 +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' - uses: actions/checkout@v3 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 - - # Format error messages: - - name: 'Replace double quotes with single quotes in rewritten format string error messages' - run: | - find . -name "*.js" -exec sed -E -i "s/Error\( format\( \"([a-zA-Z0-9]+)\"/Error\( format\( '\1'/g" {} \; - - # Format string literal error messages: - - name: 'Replace double quotes with single quotes in rewritten string literal error messages' - run: | - find . -name "*.js" -exec sed -E -i "s/Error\( format\(\"([a-zA-Z0-9]+)\"\)/Error\( format\( '\1' \)/g" {} \; - - # Format code: - - name: 'Replace double quotes with single quotes in inserted `require` calls' - run: | - find . -name "*.js" -exec sed -E -i "s/require\( ?\"@stdlib\/error-tools-fmtprodmsg\" ?\);/require\( '@stdlib\/error-tools-fmtprodmsg' \);/g" {} \; - - # 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' }} - uses: actions/checkout@v3 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - uses: actions/setup-node@v3 - with: - node-version: 16 - 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' - uses: actions/checkout@v3 - - # 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' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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' - uses: act10ns/slack@v1 - 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' - uses: actions/checkout@v3 - - # 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' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 + + ```
@@ -364,7 +363,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]. @@ -424,13 +423,13 @@ Copyright © 2016-2023. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/random-array-uniform/main/LICENSE -[@stdlib/random/base/uniform]: https://github.com/stdlib-js/random-base-uniform +[@stdlib/random/base/uniform]: https://github.com/stdlib-js/random-base-uniform/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/benchmark/benchmark.float32.factory.js b/benchmark/benchmark.float32.factory.js deleted file mode 100644 index 67e61f4..0000000 --- a/benchmark/benchmark.float32.factory.js +++ /dev/null @@ -1,96 +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 bench = require( '@stdlib/bench' ); -var isnanf = require( '@stdlib/math-base-assert-is-nanf' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var fcn = uniform.factory( 2.0, 5.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 4642816..0000000 --- a/benchmark/benchmark.float32.js +++ /dev/null @@ -1,98 +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 bench = require( '@stdlib/bench' ); -var isnanf = require( '@stdlib/math-base-assert-is-nanf' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = 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 = uniform( len, 2.0, 5.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.factory.js b/benchmark/benchmark.float64.factory.js deleted file mode 100644 index 8646a54..0000000 --- a/benchmark/benchmark.float64.factory.js +++ /dev/null @@ -1,96 +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 bench = require( '@stdlib/bench' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var fcn = uniform.factory( 2.0, 5.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 5ee0d97..0000000 --- a/benchmark/benchmark.float64.js +++ /dev/null @@ -1,98 +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 bench = require( '@stdlib/bench' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = 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 = uniform( len, 2.0, 5.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.factory.js b/benchmark/benchmark.generic.factory.js deleted file mode 100644 index 7020d62..0000000 --- a/benchmark/benchmark.generic.factory.js +++ /dev/null @@ -1,96 +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 bench = require( '@stdlib/bench' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var fcn = uniform.factory( 2.0, 5.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 06a2a83..0000000 --- a/benchmark/benchmark.generic.js +++ /dev/null @@ -1,98 +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 bench = require( '@stdlib/bench' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = 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 = uniform( len, 2.0, 5.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 30542fb..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/uniform" -%% click B href "https://github.com/stdlib-js/random-array-uniform/tree/main" -%% click C href "https://github.com/stdlib-js/random-array-uniform/tree/production" -%% click D href "https://github.com/stdlib-js/random-array-uniform/tree/esm" -%% click E href "https://github.com/stdlib-js/random-array-uniform/tree/deno" -%% click F href "https://github.com/stdlib-js/random-array-uniform/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/uniform -[production-url]: https://github.com/stdlib-js/random-array-uniform/tree/production -[deno-url]: https://github.com/stdlib-js/random-array-uniform/tree/deno -[umd-url]: https://github.com/stdlib-js/random-array-uniform/tree/umd -[esm-url]: https://github.com/stdlib-js/random-array-uniform/tree/esm \ No newline at end of file diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 4b4e952..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,192 +0,0 @@ - -{{alias}}( len, a, b[, options] ) - Returns an array containing pseudorandom numbers drawn from a continuous - uniform distribution. - - Parameters - ---------- - len: integer - Output array length. - - a: number - Minimum support. - - b: number - Maximum support. - - 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) - Output array data type. Default: 'float64'. - - Returns - ------- - out: Array|Float64Array|Float32Array - Output array. - - Examples - -------- - > var out = {{alias}}( 3, 2.0, 5.0 ) - - - -{{alias}}.factory( [a, b, ][options] ) - Returns a function for creating arrays containing pseudorandom numbers drawn - from a continuous uniform distribution. - - If provided `a` and `b`, the returned function returns random variates drawn - from the specified distribution. - - If not provided `a` and `b`, the returned function requires that both `a` - and `b` 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. - - 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 ) - - - // Provide distribution parameters: - > fcn = {{alias}}.factory( 2.0, 5.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 ) - - - // Get a copy of the current state: - > var state = {{alias}}.state - - - > out = {{alias}}( 3, 2.0, 5.0 ) - - > out = {{alias}}( 3, 2.0, 5.0 ) - - - // Set the state: - > {{alias}}.state = state; - - // Regenerate a previous array: - > out = {{alias}}( 3, 2.0, 5.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 a087b98..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,355 +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. -*/ - -import random = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - random( 10, 2, 3 ); // $ExpectType RandomArray - random( 10, 1, 2 ); // $ExpectType RandomArray - random( 10, 1, 2, {} ); // $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 ); // $ExpectError - random( true, 2.0, 5.0 ); // $ExpectError - random( false, 2.0, 5.0 ); // $ExpectError - random( null, 2.0, 5.0 ); // $ExpectError - random( [], 2.0, 5.0 ); // $ExpectError - random( {}, 2.0, 5.0 ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - random( '5', 2.0, 5.0, {} ); // $ExpectError - random( true, 2.0, 5.0, {} ); // $ExpectError - random( false, 2.0, 5.0, {} ); // $ExpectError - random( null, 2.0, 5.0, {} ); // $ExpectError - random( [], 2.0, 5.0, {} ); // $ExpectError - random( {}, 2.0, 5.0, {} ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.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 ); // $ExpectError - random( 10, true, 5.0 ); // $ExpectError - random( 10, false, 5.0 ); // $ExpectError - random( 10, null, 5.0 ); // $ExpectError - random( 10, [], 5.0 ); // $ExpectError - random( 10, {}, 5.0 ); // $ExpectError - random( 10, ( x: number ): number => x, 5.0 ); // $ExpectError - - random( 10, '5', 5.0, {} ); // $ExpectError - random( 10, true, 5.0, {} ); // $ExpectError - random( 10, false, 5.0, {} ); // $ExpectError - random( 10, null, 5.0, {} ); // $ExpectError - random( 10, [], 5.0, {} ); // $ExpectError - random( 10, {}, 5.0, {} ); // $ExpectError - random( 10, ( x: number ): number => x, 5.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' ); // $ExpectError - random( 10, 2.0, true ); // $ExpectError - random( 10, 2.0, false ); // $ExpectError - random( 10, 2.0, null ); // $ExpectError - random( 10, 2.0, [] ); // $ExpectError - random( 10, 2.0, {} ); // $ExpectError - random( 10, 2.0, ( x: number ): number => x ); // $ExpectError - - random( 10, 2.0, '5', {} ); // $ExpectError - random( 10, 2.0, true, {} ); // $ExpectError - random( 10, 2.0, false, {} ); // $ExpectError - random( 10, 2.0, null, {} ); // $ExpectError - random( 10, 2.0, [], {} ); // $ExpectError - random( 10, 2.0, {}, {} ); // $ExpectError - random( 10, 2.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, '5' ); // $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, [] ); // $ExpectError - random( 10, 2.0, 5.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, { 'dtype': 123 } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': null } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - random( 10, 2.0, 5.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 -} - -// Attached to main export is a `factory` method which returns a function... -{ - random.factory( 2.0, 5.0 ); // $ExpectType UnaryFunction - random.factory( 2.0, 5.0, { 'copy': false } ); // $ExpectType UnaryFunction - - random.factory(); // $ExpectType TernaryFunction - random.factory( { 'copy': false } ); // $ExpectType TernaryFunction -} - -// The `factory` method returns a function which returns an array... -{ - const fcn1 = random.factory( 2.0, 5.0 ); - fcn1( 10 ); // $ExpectType RandomArray - - const fcn2 = random.factory(); - fcn2( 10, 2.0, 5.0 ); // $ExpectType RandomArray -} - -// The compiler throws an error if the `factory` method is provided invalid arguments... -{ - random.factory( '5', 5.0 ); // $ExpectError - random.factory( true, 5.0 ); // $ExpectError - random.factory( false, 5.0 ); // $ExpectError - random.factory( [], 5.0 ); // $ExpectError - random.factory( {}, 5.0 ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0 ); // $ExpectError - - random.factory( '5', 5.0, {} ); // $ExpectError - random.factory( true, 5.0, {} ); // $ExpectError - random.factory( false, 5.0, {} ); // $ExpectError - random.factory( [], 5.0, {} ); // $ExpectError - random.factory( {}, 5.0, {} ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0, {} ); // $ExpectError - - random.factory( 2.0, '5' ); // $ExpectError - random.factory( 2.0, true ); // $ExpectError - random.factory( 2.0, false ); // $ExpectError - random.factory( 2.0, [] ); // $ExpectError - random.factory( 2.0, {} ); // $ExpectError - random.factory( 2.0, ( x: number ): number => x ); // $ExpectError - - random.factory( 2.0, '5', {} ); // $ExpectError - random.factory( 2.0, true, {} ); // $ExpectError - random.factory( 2.0, false, {} ); // $ExpectError - random.factory( 2.0, [], {} ); // $ExpectError - random.factory( 2.0, {}, {} ); // $ExpectError - random.factory( 2.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, 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, { 'prng': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'seed': true } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': [ 'a' ] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'state': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': {} } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': true ); // $ExpectError - random.factory( 2.0, 5.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, { 'copy': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'dtype': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - random.factory( 2.0, 5.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, {}, {} ); // $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 ); - 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 ); // $ExpectError - fcn2( false, 2.0, 5.0 ); // $ExpectError - fcn2( '5', 2.0, 5.0 ); // $ExpectError - fcn2( [], 2.0, 5.0 ); // $ExpectError - fcn2( {}, 2.0, 5.0 ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - fcn2( true, 2.0, 5.0, {} ); // $ExpectError - fcn2( false, 2.0, 5.0, {} ); // $ExpectError - fcn2( '5', 2.0, 5.0, {} ); // $ExpectError - fcn2( [], 2.0, 5.0, {} ); // $ExpectError - fcn2( {}, 2.0, 5.0, {} ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0, {} ); // $ExpectError - - fcn2( 10, true, 5.0 ); // $ExpectError - fcn2( 10, false, 5.0 ); // $ExpectError - fcn2( 10, '5', 5.0 ); // $ExpectError - fcn2( 10, [], 5.0 ); // $ExpectError - fcn2( 10, {}, 5.0 ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0 ); // $ExpectError - - fcn2( 10, true, 5.0, {} ); // $ExpectError - fcn2( 10, false, 5.0, {} ); // $ExpectError - fcn2( 10, '5', 5.0, {} ); // $ExpectError - fcn2( 10, [], 5.0, {} ); // $ExpectError - fcn2( 10, {}, 5.0, {} ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0, {} ); // $ExpectError - - fcn2( 10, 2.0, true ); // $ExpectError - fcn2( 10, 2.0, false ); // $ExpectError - fcn2( 10, 2.0, '5' ); // $ExpectError - fcn2( 10, 2.0, [] ); // $ExpectError - fcn2( 10, 2.0, {} ); // $ExpectError - fcn2( 10, 2.0, ( x: number ): number => x ); // $ExpectError - - fcn2( 10, 2.0, true, {} ); // $ExpectError - fcn2( 10, 2.0, false, {} ); // $ExpectError - fcn2( 10, 2.0, '5', {} ); // $ExpectError - fcn2( 10, 2.0, [], {} ); // $ExpectError - fcn2( 10, 2.0, {}, {} ); // $ExpectError - fcn2( 10, 2.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, { 'dtype': 123 } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': null } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError - - const fcn2 = random.factory( 2.0, 5.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 ); - fcn1(); // $ExpectError - fcn1( 1, 1, 1 ); // $ExpectError - - const fcn2 = random.factory(); - fcn2(); // $ExpectError - fcn2( 1 ); // $ExpectError - fcn2( 1, 1, 1, 1 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index c485546..0000000 --- a/examples/index.js +++ /dev/null @@ -1,48 +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'; - -var logEach = require( '@stdlib/console-log-each' ); -var uniform = require( './../lib' ); - -// Create a function for generating random arrays originating from the same state: -var random = uniform.factory( 2.0, 5.0, { - 'state': uniform.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 = uniform.factory( 2.0, 5.0, { - 'state': uniform.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 458c488..7f0bfdf 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 2.0 -/// +/// import { FloatDataType, 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..a4cb981 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-accessor@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-write-accessor@esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-constant-function@esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-noop@v0.0.14-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/random-base-uniform@esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-typed-real-float-ctors@esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-nullary@esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@esm/index.mjs";import f from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.0.2-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/array-typed-real-float-dtypes@esm/index.mjs";import h from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@esm/index.mjs";var u="float64",c=a();function y(e,t){return h(t)?j(t,"dtype")&&(e.dtype=t.dtype,c.indexOf(e.dtype)<0)?new TypeError(f("null3t","dtype",c.join('", "'),e.dtype)):null:new TypeError(f("null2h",t))}function g(){var a,h,j,c,g,b;if(j={dtype:u},0===(h=arguments.length))g=d,c=x;else if(1===h){if(a=arguments[0],g=d.factory(a),b=y(j,a))throw b;c=x}else if(2===h)g=d.factory(arguments[0],arguments[1]),c=v;else if(3===h){if(a=arguments[2],g=d.factory(arguments[0],arguments[1],a),b=y(j,a))throw b;c=v}return a&&a.prng?(e(c,"seed",null),e(c,"seedLength",null),s(c,"state",r(null),i),e(c,"stateLength",null),e(c,"byteLength",null)):(n(c,"seed",w),n(c,"seedLength",L),s(c,"state",P,R),n(c,"stateLength",G),n(c,"byteLength",N)),e(c,"PRNG",g.PRNG),c;function v(e,n){var s,r,i,d;if(!t(e))throw new TypeError(f("null2p",e));if(d={},arguments.length>1&&(r=y(d,n)))throw r;return"generic"===(i=d.dtype||j.dtype)?l(e,g):(s=new(o(i))(e),m([s],[e],[1],g),s)}function x(e,n,s,r){var i,d,m,a;if(!t(e))throw new TypeError(f("null2p",e));if(a={},arguments.length>3&&(d=y(a,r)))throw d;return"generic"===(m=a.dtype||j.dtype)?l(e,h):(i=new(o(m))(e),p([[n],[s],i],[e],[0,0,1],g),i);function h(){return g(n,s)}}function w(){return c.PRNG.seed}function L(){return c.PRNG.seedLength}function G(){return c.PRNG.stateLength}function N(){return c.PRNG.byteLength}function P(){return c.PRNG.state}function R(e){c.PRNG.state=e}}c.push("generic");var b=g();e(b,"factory",g);export{b as default,g as factory}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..4984bd1 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/factory.js","../lib/main.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 dtypes from '@stdlib/array-typed-real-float-dtypes';\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes();\nDTYPES.push( 'generic' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( 'null2h', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( DTYPES.indexOf( opts.dtype ) < 0 ) {\n\t\t\treturn new TypeError( format( 'null3t', 'dtype', DTYPES.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport setReadOnlyAccessor from '@stdlib/utils-define-nonenumerable-read-only-accessor';\nimport setReadWriteAccessor from '@stdlib/utils-define-nonenumerable-read-write-accessor';\nimport constantFunction from '@stdlib/utils-constant-function';\nimport noop from '@stdlib/utils-noop';\nimport base from '@stdlib/random-base-uniform';\nimport ctors from '@stdlib/array-typed-real-float-ctors';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport nullary from '@stdlib/strided-base-nullary';\nimport binary from '@stdlib/strided-base-binary';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution.\n*\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\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 {RangeError} `a` must be less than `b`\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 uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10 );\n* // returns \n*\n* @example\n* var uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nfunction factory() {\n\tvar options;\n\tvar nargs;\n\tvar opts;\n\tvar rand;\n\tvar prng;\n\tvar err;\n\n\topts = {\n\t\t'dtype': defaults.dtype\n\t};\n\n\tnargs = arguments.length;\n\tif ( nargs === 0 ) {\n\t\tprng = base;\n\t\trand = uniform2;\n\t} else if ( nargs === 1 ) {\n\t\toptions = arguments[ 0 ];\n\t\tprng = base.factory( options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform2;\n\t} else if ( nargs === 2 ) {\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ] );\n\t\trand = uniform1;\n\t} else if ( nargs === 3 ) {\n\t\toptions = arguments[ 2 ];\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ], options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform1;\n\t}\n\tif ( options && options.prng ) {\n\t\tsetReadOnly( rand, 'seed', null );\n\t\tsetReadOnly( rand, 'seedLength', null );\n\t\tsetReadWriteAccessor( rand, 'state', constantFunction( null ), noop );\n\t\tsetReadOnly( rand, 'stateLength', null );\n\t\tsetReadOnly( rand, 'byteLength', null );\n\t} else {\n\t\tsetReadOnlyAccessor( rand, 'seed', getSeed );\n\t\tsetReadOnlyAccessor( rand, 'seedLength', getSeedLength );\n\t\tsetReadWriteAccessor( rand, 'state', getState, setState );\n\t\tsetReadOnlyAccessor( rand, 'stateLength', getStateLength );\n\t\tsetReadOnlyAccessor( rand, 'byteLength', getStateSize );\n\t}\n\tsetReadOnly( rand, 'PRNG', prng.PRNG );\n\treturn rand;\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform1( len, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( 'null2p', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 1 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, prng );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tnullary( [ out ], [ len ], [ 1 ], prng );\n\t\treturn out;\n\t}\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {number} a - minimum support\n\t* @param {number} b - maximum support\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform2( len, a, b, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( 'null2p', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 3 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\t// NOTE: we could alternatively use the PRNG factory function to create a PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. Decision made here to avoid this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom number. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in a return value of `NaN`.\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, wrapper );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tbinary( [ [ a ], [ b ], out ], [ len ], [ 0, 0, 1 ], prng );\n\t\treturn out;\n\n\t\t/**\n\t\t* Applies parameters to a pseudorandom number generator function.\n\t\t*\n\t\t* @private\n\t\t* @returns {number} pseudorandom number\n\t\t*/\n\t\tfunction wrapper() {\n\t\t\treturn prng( a, b );\n\t\t}\n\t}\n\n\t/**\n\t* Returns the PRNG seed.\n\t*\n\t* @private\n\t* @returns {PRNGSeedMT19937} seed\n\t*/\n\tfunction getSeed() {\n\t\treturn rand.PRNG.seed;\n\t}\n\n\t/**\n\t* Returns the PRNG seed length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} seed length\n\t*/\n\tfunction getSeedLength() {\n\t\treturn rand.PRNG.seedLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state length\n\t*/\n\tfunction getStateLength() {\n\t\treturn rand.PRNG.stateLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state size (in bytes).\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state size (in bytes)\n\t*/\n\tfunction getStateSize() {\n\t\treturn rand.PRNG.byteLength;\n\t}\n\n\t/**\n\t* Returns the current pseudorandom number generator state.\n\t*\n\t* @private\n\t* @returns {PRNGStateMT19937} current state\n\t*/\n\tfunction getState() {\n\t\treturn rand.PRNG.state;\n\t}\n\n\t/**\n\t* Sets the pseudorandom number generator state.\n\t*\n\t* @private\n\t* @param {PRNGStateMT19937} s - generator state\n\t* @throws {Error} must provide a valid state\n\t*/\n\tfunction setState( s ) {\n\t\trand.PRNG.state = s;\n\t}\n}\n\n\n// EXPORTS //\n\nexport default factory;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @name uniform\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\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 = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar uniform = factory();\n\n\n// EXPORTS //\n\nexport default uniform;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @module @stdlib/random-array-uniform\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.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\" }\n"],"names":["DTYPES","dtypes","validate","opts","options","isObject","hasOwnProp","dtype","indexOf","TypeError","format","join","factory","nargs","rand","prng","err","defaults","arguments","length","base","uniform2","uniform1","setReadOnly","setReadWriteAccessor","constantFunction","noop","setReadOnlyAccessor","getSeed","getSeedLength","getState","setState","getStateLength","getStateSize","PRNG","len","out","dt","o","isNonNegativeInteger","filledBy","ctors","nullary","a","b","wrapper","binary","seed","seedLength","stateLength","byteLength","state","s","push","uniform","main"],"mappings":";;07CA8BIA,EAASC,IAyBb,SAASC,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,WACzBD,EAAKI,MAAQH,EAAQG,MAChBP,EAAOQ,QAASL,EAAKI,OAAU,GAC5B,IAAIE,UAAWC,EAAQ,SAAU,QAASV,EAAOW,KAAM,QAAUR,EAAKI,QAGxE,KARC,IAAIE,UAAWC,EAAQ,SAAUN,GAS1C,CCSA,SAASQ,IACR,IAAIR,EACAS,EACAV,EACAW,EACAC,EACAC,EAOJ,GALAb,EAAO,CACNI,MAASU,GAIK,KADfJ,EAAQK,UAAUC,QAEjBJ,EAAOK,EACPN,EAAOO,OACD,GAAe,IAAVR,EAAc,CAIzB,GAHAT,EAAUc,UAAW,GACrBH,EAAOK,EAAKR,QAASR,GACrBY,EAAMd,EAAUC,EAAMC,GAErB,MAAMY,EAEPF,EAAOO,CACT,MAAQ,GAAe,IAAVR,EACXE,EAAOK,EAAKR,QAASM,UAAW,GAAKA,UAAW,IAChDJ,EAAOQ,OACD,GAAe,IAAVT,EAAc,CAIzB,GAHAT,EAAUc,UAAW,GACrBH,EAAOK,EAAKR,QAASM,UAAW,GAAKA,UAAW,GAAKd,GACrDY,EAAMd,EAAUC,EAAMC,GAErB,MAAMY,EAEPF,EAAOQ,CACP,CAeD,OAdKlB,GAAWA,EAAQW,MACvBQ,EAAaT,EAAM,OAAQ,MAC3BS,EAAaT,EAAM,aAAc,MACjCU,EAAsBV,EAAM,QAASW,EAAkB,MAAQC,GAC/DH,EAAaT,EAAM,cAAe,MAClCS,EAAaT,EAAM,aAAc,QAEjCa,EAAqBb,EAAM,OAAQc,GACnCD,EAAqBb,EAAM,aAAce,GACzCL,EAAsBV,EAAM,QAASgB,EAAUC,GAC/CJ,EAAqBb,EAAM,cAAekB,GAC1CL,EAAqBb,EAAM,aAAcmB,IAE1CV,EAAaT,EAAM,OAAQC,EAAKmB,MACzBpB,EAcP,SAASQ,EAAUa,EAAK/B,GACvB,IACIgC,EACApB,EACAqB,EACAC,EACJ,IAAMC,EAAsBJ,GAC3B,MAAM,IAAI1B,UAAWC,EAAQ,SAAUyB,IAGxC,GADAG,EAAI,CAAA,EACCpB,UAAUC,OAAS,IACvBH,EAAMd,EAAUoC,EAAGlC,IAElB,MAAMY,EAIR,MAAY,aADZqB,EAAKC,EAAE/B,OAASJ,EAAKI,OAEbiC,EAAUL,EAAKpB,IAGvBqB,EAAM,IADCK,EAAOJ,GACR,CAAUF,GAChBO,EAAS,CAAEN,GAAO,CAAED,GAAO,CAAE,GAAKpB,GAC3BqB,EACP,CAgBD,SAASf,EAAUc,EAAKQ,EAAGC,EAAGxC,GAC7B,IACIgC,EACApB,EACAqB,EACAC,EACJ,IAAMC,EAAsBJ,GAC3B,MAAM,IAAI1B,UAAWC,EAAQ,SAAUyB,IAGxC,GADAG,EAAI,CAAA,EACCpB,UAAUC,OAAS,IACvBH,EAAMd,EAAUoC,EAAGlC,IAElB,MAAMY,EAKR,MAAY,aADZqB,EAAKC,EAAE/B,OAASJ,EAAKI,OAEbiC,EAAUL,EAAKU,IAGvBT,EAAM,IADCK,EAAOJ,GACR,CAAUF,GAChBW,EAAQ,CAAE,CAAEH,GAAK,CAAEC,GAAKR,GAAO,CAAED,GAAO,CAAE,EAAG,EAAG,GAAKpB,GAC9CqB,GAQP,SAASS,IACR,OAAO9B,EAAM4B,EAAGC,EAChB,CACD,CAQD,SAAShB,IACR,OAAOd,EAAKoB,KAAKa,IACjB,CAQD,SAASlB,IACR,OAAOf,EAAKoB,KAAKc,UACjB,CAQD,SAAShB,IACR,OAAOlB,EAAKoB,KAAKe,WACjB,CAQD,SAAShB,IACR,OAAOnB,EAAKoB,KAAKgB,UACjB,CAQD,SAASpB,IACR,OAAOhB,EAAKoB,KAAKiB,KACjB,CASD,SAASpB,EAAUqB,GAClBtC,EAAKoB,KAAKiB,MAAQC,CAClB,CACF,CDrPApD,EAAOqD,KAAM,WEqBV,IAACC,EAAU1C,ICiBdW,EAAAgC,EAAA,UAAA3C"} \ No newline at end of file diff --git a/lib/defaults.json b/lib/defaults.json deleted file mode 100644 index 83f4438..0000000 --- a/lib/defaults.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "dtype": "float64" -} diff --git a/lib/factory.js b/lib/factory.js deleted file mode 100644 index 9f232af..0000000 --- a/lib/factory.js +++ /dev/null @@ -1,282 +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 isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var setReadOnlyAccessor = require( '@stdlib/utils-define-nonenumerable-read-only-accessor' ); -var setReadWriteAccessor = require( '@stdlib/utils-define-nonenumerable-read-write-accessor' ); -var constantFunction = require( '@stdlib/utils-constant-function' ); -var noop = require( '@stdlib/utils-noop' ); -var base = require( '@stdlib/random-base-uniform' ); -var ctors = require( '@stdlib/array-typed-real-float-ctors' ); -var filledBy = require( '@stdlib/array-base-filled-by' ); -var nullary = require( '@stdlib/strided-base-nullary' ); -var binary = require( '@stdlib/strided-base-binary' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution. -* -* @param {number} [a] - minimum support -* @param {number} [b] - maximum support -* @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 {RangeError} `a` must be less than `b` -* @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 uniform = factory( 2.0, 5.0 ); -* // returns -* -* var arr = uniform( 10 ); -* // returns -* -* @example -* var uniform = factory( 2.0, 5.0 ); -* // returns -* -* var arr = uniform( 10, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -function factory() { - var options; - var nargs; - var opts; - var rand; - var prng; - var err; - - opts = { - 'dtype': defaults.dtype - }; - - nargs = arguments.length; - if ( nargs === 0 ) { - prng = base; - rand = uniform2; - } else if ( nargs === 1 ) { - options = arguments[ 0 ]; - prng = base.factory( options ); - err = validate( opts, options ); - if ( err ) { - throw err; - } - rand = uniform2; - } else if ( nargs === 2 ) { - prng = base.factory( arguments[ 0 ], arguments[ 1 ] ); - rand = uniform1; - } else if ( nargs === 3 ) { - options = arguments[ 2 ]; - prng = base.factory( arguments[ 0 ], arguments[ 1 ], options ); - err = validate( opts, options ); - if ( err ) { - throw err; - } - rand = uniform1; - } - if ( options && options.prng ) { - setReadOnly( rand, 'seed', null ); - setReadOnly( rand, 'seedLength', null ); - setReadWriteAccessor( rand, 'state', constantFunction( null ), noop ); - setReadOnly( rand, 'stateLength', null ); - setReadOnly( rand, 'byteLength', null ); - } else { - setReadOnlyAccessor( rand, 'seed', getSeed ); - setReadOnlyAccessor( rand, 'seedLength', getSeedLength ); - setReadWriteAccessor( rand, 'state', getState, setState ); - setReadOnlyAccessor( rand, 'stateLength', getStateLength ); - setReadOnlyAccessor( rand, 'byteLength', getStateSize ); - } - setReadOnly( rand, 'PRNG', prng.PRNG ); - return rand; - - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @private - * @param {NonNegativeInteger} len - array length - * @param {Options} [options] - function options - * @param {string} [options.dtype] - 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 - */ - function uniform1( len, options ) { - var ctor; - var out; - var err; - var dt; - var o; - if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( 'null2p', len ) ); - } - o = {}; - if ( arguments.length > 1 ) { - err = validate( o, options ); - if ( err ) { - throw err; - } - } - dt = o.dtype || opts.dtype; - if ( dt === 'generic' ) { - return filledBy( len, prng ); - } - ctor = ctors( dt ); - out = new ctor( len ); - nullary( [ out ], [ len ], [ 1 ], prng ); - return out; - } - - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @private - * @param {NonNegativeInteger} len - array length - * @param {number} a - minimum support - * @param {number} b - maximum support - * @param {Options} [options] - function options - * @param {string} [options.dtype] - 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 - */ - function uniform2( len, a, b, options ) { - var ctor; - var out; - var err; - var dt; - var o; - if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( 'null2p', len ) ); - } - o = {}; - if ( arguments.length > 3 ) { - err = validate( o, options ); - if ( err ) { - throw err; - } - } - // NOTE: we could alternatively use the PRNG factory function to create a PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. Decision made here to avoid this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom number. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in a return value of `NaN`. - dt = o.dtype || opts.dtype; - if ( dt === 'generic' ) { - return filledBy( len, wrapper ); - } - ctor = ctors( dt ); - out = new ctor( len ); - binary( [ [ a ], [ b ], out ], [ len ], [ 0, 0, 1 ], prng ); - return out; - - /** - * Applies parameters to a pseudorandom number generator function. - * - * @private - * @returns {number} pseudorandom number - */ - function wrapper() { - return prng( a, b ); - } - } - - /** - * Returns the PRNG seed. - * - * @private - * @returns {PRNGSeedMT19937} seed - */ - function getSeed() { - return rand.PRNG.seed; - } - - /** - * Returns the PRNG seed length. - * - * @private - * @returns {PositiveInteger} seed length - */ - function getSeedLength() { - return rand.PRNG.seedLength; - } - - /** - * Returns the PRNG state length. - * - * @private - * @returns {PositiveInteger} state length - */ - function getStateLength() { - return rand.PRNG.stateLength; - } - - /** - * Returns the PRNG state size (in bytes). - * - * @private - * @returns {PositiveInteger} state size (in bytes) - */ - function getStateSize() { - return rand.PRNG.byteLength; - } - - /** - * Returns the current pseudorandom number generator state. - * - * @private - * @returns {PRNGStateMT19937} current state - */ - function getState() { - return rand.PRNG.state; - } - - /** - * Sets the pseudorandom number generator state. - * - * @private - * @param {PRNGStateMT19937} s - generator state - * @throws {Error} must provide a valid state - */ - function setState( s ) { - rand.PRNG.state = s; - } -} - - -// EXPORTS // - -module.exports = factory; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 0077f00..0000000 --- a/lib/index.js +++ /dev/null @@ -1,77 +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'; - -/** -* Create an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. -* -* @module @stdlib/random-array-uniform -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var arr = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var arr = uniform( 10, 2.0, 5.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var rand = uniform.factory( 2.0, 5.0 ); -* // returns -* -* var arr = rand( 10 ); -* // returns -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var rand = uniform.factory( 2.0, 5.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" } diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index da0d9b1..0000000 --- a/lib/main.js +++ /dev/null @@ -1,58 +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 factory = require( './factory.js' ); - - -// MAIN // - -/** -* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. -* -* @name uniform -* @type {Function} -* @param {NonNegativeInteger} len - array length -* @param {number} a - minimum support -* @param {number} b - maximum support -* @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 = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var arr = uniform( 10, 2.0, 5.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -var uniform = factory(); - - -// EXPORTS // - -module.exports = uniform; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index 3629aaf..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,72 +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 dtypes = require( '@stdlib/array-typed-real-float-dtypes' ); -var isObject = require( '@stdlib/assert-is-plain-object' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// VARIABLES // - -var DTYPES = dtypes(); -DTYPES.push( 'generic' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Options} options - function options -* @param {string} [options.dtype] - output array data type -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var options = { -* 'dtype': 'float64' -* }; -* var err = validate( opts, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( 'null2h', options ) ); - } - if ( hasOwnProp( options, 'dtype' ) ) { - opts.dtype = options.dtype; - if ( DTYPES.indexOf( opts.dtype ) < 0 ) { - return new TypeError( format( 'null3t', 'dtype', DTYPES.join( '", "' ), opts.dtype ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index 8b6d28d..621da6a 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 continuous uniform 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,55 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-filled-by": "^0.0.2", - "@stdlib/array-typed-real-float-ctors": "^0.0.1", - "@stdlib/array-typed-real-float-dtypes": "^0.0.1", - "@stdlib/assert-has-own-property": "^0.0.7", - "@stdlib/assert-is-nonnegative-integer": "^0.0.7", - "@stdlib/assert-is-plain-object": "^0.0.7", - "@stdlib/random-base-uniform": "^0.0.6", - "@stdlib/strided-base-binary": "^0.0.8", - "@stdlib/strided-base-nullary": "^0.0.7", - "@stdlib/error-tools-fmtprodmsg": "^0.0.2", - "@stdlib/types": "^0.0.14", - "@stdlib/utils-constant-function": "^0.0.8", - "@stdlib/utils-define-nonenumerable-read-only-accessor": "^0.0.7", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.7", - "@stdlib/utils-define-nonenumerable-read-write-accessor": "^0.0.7", - "@stdlib/utils-noop": "^0.0.14" - }, - "devDependencies": { - "@stdlib/array-float32": "^0.0.6", - "@stdlib/array-float64": "^0.0.6", - "@stdlib/array-uint32": "^0.0.6", - "@stdlib/assert-is-uint32array": "^0.0.8", - "@stdlib/bench": "^0.0.12", - "@stdlib/console-log-each": "^0.0.2", - "@stdlib/constants-uint32-max": "^0.0.7", - "@stdlib/math-base-assert-is-nan": "^0.0.8", - "@stdlib/math-base-assert-is-nanf": "^0.0.8", - "@stdlib/math-base-special-pow": "^0.0.7", - "@stdlib/random-base-minstd": "^0.0.6", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdmath", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..1bbae74 --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/test.factory.js b/test/test.factory.js deleted file mode 100644 index a869e75..0000000 --- a/test/test.factory.js +++ /dev/null @@ -1,1328 +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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -tape( 'the function throws an error if the second distribution parameter is less than the first distribution parameter', function test( t ) { - var values; - var i; - - values = [ - [ 0.0, 0.0 ], - [ -2.0, -4.0 ], - [ 2.0, 1.0 ] - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( arr ) { - return function badValue() { - factory( arr[0], arr[1] ); - }; - } -}); - -tape( 'the function throws an error if the second distribution parameter is less than the first distribution parameter (options)', function test( t ) { - var values; - var i; - - values = [ - [ 0.0, 0.0 ], - [ -2.0, -4.0 ], - [ 2.0, 1.0 ] - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( arr ) { - return function badValue() { - factory( arr[0], arr[1], {} ); - }; - } -}); - -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, 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, { - '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, { - '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, { - '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, { - '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, { - '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, { - '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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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 ); - - 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 ); - - 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, { - '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 ); - - 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 ); - 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( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory(); - actual = random( 10, 2.0, 5.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( typeof actual[ i ], 'number', '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 ); - - 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 ); - - 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 ); - - 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 that generates `NaN` values if the first distribution parameter is greater than or equal to the second distribution parameter', function test( t ) { - var random; - var values; - var actual; - var i; - var j; - - random = factory(); - values = [ - [ 2.0, 1.0 ], - [ -3.0, -4.0 ], - [ 0.0, 0.0 ] - ]; - - for ( i = 0; i < values.length; i++ ) { - actual = random( 10, values[ i ][ 0 ], values[ i ][ 1 ] ); - for ( j = 0; j < actual.length; j++ ) { - t.strictEqual( isnan( actual[ j ] ), true, 'returns expected value when provided '+values[ 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, { - '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 ); - - 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, { - '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( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'float64' - }); - actual = random( 10, 2.0, 5.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( typeof actual[ i ], 'number', '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, { - '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( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'float32' - }); - actual = random( 10, 2.0, 5.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( typeof actual[ i ], 'number', '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, { - '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 ); - - 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, { - '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, { - '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 ); - - // 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, { - '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 ); - - // 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, { - '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 ); - - 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, { - 'prng': randu.normalized - }); - - randu = minstd.factory({ - 'seed': seed - }); - random2 = factory( 2.0, 5.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 ); - arr2 = random2( 10, 2.0, 5.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 c4fb6d3..0000000 --- a/test/test.js +++ /dev/null @@ -1,69 +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 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 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 37b0080..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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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, 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, { - '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 ); - - 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( typeof actual[ i ], 'number', '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, { - '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( typeof actual[ i ], 'number', '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, { - '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( typeof actual[ i ], 'number', '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, { - '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 ); - } - // Capture the current state: - state = random.state; - - // Move to a future state... - arr = random( 10, 2.0, 5.0 ); - for ( i = 0; i < 100; i++ ) { - random( 2, 2.0, 5.0 ); - } - // Set the state: - random.state = state; - - // Replay previously generated values: - t.deepEqual( random( 10, 2.0, 5.0 ), arr, 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.validate.js b/test/test.validate.js deleted file mode 100644 index c515526..0000000 --- a/test/test.validate.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 validate = require( './../lib/validate.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.equal( typeof validate, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function returns an error if provided an options argument which is not an object', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - void 0, - null, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, values[ i ] ); - t.equal( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided a `dtype` option which is not a supported data type', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - -5, - NaN, - true, - false, - void 0, - null, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, { - 'dtype': values[ i ] - }); - t.equal( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns null if all options are valid', function test( t ) { - var options; - var opts; - var err; - - options = { - 'dtype': 'float64' - }; - opts = {}; - err = validate( opts, options ); - - t.equal( err, null, 'returns null' ); - t.deepEqual( opts, options, 'sets option values' ); - - t.end(); -}); - -tape( 'the function ignores unrecognized/unsupported options', function test( t ) { - var options; - var opts; - var err; - - options = { - 'beep': true, - 'boop': 'bop' - }; - opts = {}; - err = validate( opts, options ); - - t.equal( err, null, 'returns null' ); - t.deepEqual( opts, {}, 'does not set any option values' ); - t.end(); -}); From f9cac16965e38270c9a82323e613de0cc197fcf9 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 15 Feb 2023 10:21:28 +0000 Subject: [PATCH 15/82] Transform error messages --- lib/factory.js | 6 +++--- lib/validate.js | 6 +++--- package.json | 2 +- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/lib/factory.js b/lib/factory.js index 22ec236..9f232af 100644 --- a/lib/factory.js +++ b/lib/factory.js @@ -31,7 +31,7 @@ var ctors = require( '@stdlib/array-typed-real-float-ctors' ); var filledBy = require( '@stdlib/array-base-filled-by' ); var nullary = require( '@stdlib/strided-base-nullary' ); var binary = require( '@stdlib/strided-base-binary' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -144,7 +144,7 @@ function factory() { var dt; var o; if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) ); + throw new TypeError( format( 'null2p', len ) ); } o = {}; if ( arguments.length > 1 ) { @@ -184,7 +184,7 @@ function factory() { var dt; var o; if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) ); + throw new TypeError( format( 'null2p', len ) ); } o = {}; if ( arguments.length > 3 ) { diff --git a/lib/validate.js b/lib/validate.js index 40b9723..3629aaf 100644 --- a/lib/validate.js +++ b/lib/validate.js @@ -23,7 +23,7 @@ var dtypes = require( '@stdlib/array-typed-real-float-dtypes' ); var isObject = require( '@stdlib/assert-is-plain-object' ); var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // VARIABLES // @@ -55,12 +55,12 @@ DTYPES.push( 'generic' ); */ function validate( opts, options ) { if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); + return new TypeError( format( 'null2h', options ) ); } if ( hasOwnProp( options, 'dtype' ) ) { opts.dtype = options.dtype; if ( DTYPES.indexOf( opts.dtype ) < 0 ) { - return new TypeError( format( 'invalid option. `%s` option must be one of the following: "%s". Option: `%s`.', 'dtype', DTYPES.join( '", "' ), opts.dtype ) ); + return new TypeError( format( 'null3t', 'dtype', DTYPES.join( '", "' ), opts.dtype ) ); } } return null; diff --git a/package.json b/package.json index 486f4d2..8b6d28d 100644 --- a/package.json +++ b/package.json @@ -46,7 +46,7 @@ "@stdlib/random-base-uniform": "^0.0.6", "@stdlib/strided-base-binary": "^0.0.8", "@stdlib/strided-base-nullary": "^0.0.7", - "@stdlib/string-format": "^0.0.3", + "@stdlib/error-tools-fmtprodmsg": "^0.0.2", "@stdlib/types": "^0.0.14", "@stdlib/utils-constant-function": "^0.0.8", "@stdlib/utils-define-nonenumerable-read-only-accessor": "^0.0.7", From 2e01e2e12f170146d814d6615c60ea2b618cc16c Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 15 Feb 2023 10:29:48 +0000 Subject: [PATCH 16/82] Remove files --- index.d.ts | 245 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6427 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 7f0bfdf..0000000 --- a/index.d.ts +++ /dev/null @@ -1,245 +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. -*/ - -// TypeScript Version: 2.0 - -/// - -import { FloatDataType, FloatTypedArray } from '@stdlib/types/array'; -import * as random from '@stdlib/types/random'; - -/** -* Supported data types. -*/ -type DataType = FloatDataType | 'generic'; - -/** -* 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 { - /** - * Default output array data type. Default: 'float64'. - */ - 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 continuous uniform distribution with pre-specified parameter values. -*/ -interface UnaryFunction extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @param len - array length - * @param options - function options - * @returns output array - */ - ( len: number, options?: Options ): RandomArray; -} - -/** -* Interface for generating pseudorandom numbers drawn from a continuous uniform distribution without pre-specified parameter values. -*/ -interface TernaryFunction extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @param len - array length - * @param a - minimum support - * @param b - maximum support - * @param options - function options - * @returns output array - */ - ( len: number, a: number, b: number, options?: Options ): RandomArray; -} - -/** -* Interface for generating pseudorandom numbers drawn from a uniform distribution. -*/ -interface Random extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @param len - array length - * @param a - minimum support - * @param b - maximum support - * @param options - function options - * @returns output array - * - * @example - * var out = uniform( 10, 2.0, 5.0 ); - * // returns - */ - ( len: number, a: number, b: number, options?: Options ): RandomArray; - - /** - * Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution. - * - * ## Notes - * - * - When provided `a` and `b`, the returned function returns random variates drawn from the specified distribution. - * - * @param a - minimum support - * @param b - maximum support - * @param options - function options - * @throws `a` must be less than `b` - * @throws must provide a valid state - * @returns function for creating arrays - * - * @example - * var random = uniform.factory( 2.0, 5.0 ); - * - * var out = random( 10 ); - * // returns - * - * @example - * var random = uniform.factory( 2.0, 5.0, { - * 'seed': 297 - * }); - * var out = random( 10 ); - * // returns - */ - factory( a: number, b: number, options?: FactoryOptions ): UnaryFunction; - - /** - * Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution. - * - * ## Notes - * - * - When not provided `a` and `b`, the returned function requires that both `a` and `b` be provided at each invocation. - * - * @param options - function options - * @throws must provide a valid state - * @returns function for creating arrays - * - * @example - * var random = uniform.factory(); - * - * var out = random( 10, 2.0, 5.0 ); - * // returns - * - * @example - * var random = uniform.factory({ - * 'seed': 297 - * }); - * var out = random( 10, 2.0, 5.0 ); - * // returns - */ - factory( options?: FactoryOptions ): TernaryFunction; -} - -/** -* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. -* -* @param len - array length -* @param a - minimum support -* @param b - maximum support -* @param options - function options -* @returns output array -* -* @example -* var out = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var random = uniform.factory( 2.0, 5.0 ); -* -* var out = random( 10 ); -* // returns -*/ -declare var uniform: Random; - - -// EXPORTS // - -export = uniform; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index a4cb981..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-accessor@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-write-accessor@esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-constant-function@esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-noop@v0.0.14-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/random-base-uniform@esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-typed-real-float-ctors@esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-nullary@esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@esm/index.mjs";import f from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.0.2-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/array-typed-real-float-dtypes@esm/index.mjs";import h from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@esm/index.mjs";var u="float64",c=a();function y(e,t){return h(t)?j(t,"dtype")&&(e.dtype=t.dtype,c.indexOf(e.dtype)<0)?new TypeError(f("null3t","dtype",c.join('", "'),e.dtype)):null:new TypeError(f("null2h",t))}function g(){var a,h,j,c,g,b;if(j={dtype:u},0===(h=arguments.length))g=d,c=x;else if(1===h){if(a=arguments[0],g=d.factory(a),b=y(j,a))throw b;c=x}else if(2===h)g=d.factory(arguments[0],arguments[1]),c=v;else if(3===h){if(a=arguments[2],g=d.factory(arguments[0],arguments[1],a),b=y(j,a))throw b;c=v}return a&&a.prng?(e(c,"seed",null),e(c,"seedLength",null),s(c,"state",r(null),i),e(c,"stateLength",null),e(c,"byteLength",null)):(n(c,"seed",w),n(c,"seedLength",L),s(c,"state",P,R),n(c,"stateLength",G),n(c,"byteLength",N)),e(c,"PRNG",g.PRNG),c;function v(e,n){var s,r,i,d;if(!t(e))throw new TypeError(f("null2p",e));if(d={},arguments.length>1&&(r=y(d,n)))throw r;return"generic"===(i=d.dtype||j.dtype)?l(e,g):(s=new(o(i))(e),m([s],[e],[1],g),s)}function x(e,n,s,r){var i,d,m,a;if(!t(e))throw new TypeError(f("null2p",e));if(a={},arguments.length>3&&(d=y(a,r)))throw d;return"generic"===(m=a.dtype||j.dtype)?l(e,h):(i=new(o(m))(e),p([[n],[s],i],[e],[0,0,1],g),i);function h(){return g(n,s)}}function w(){return c.PRNG.seed}function L(){return c.PRNG.seedLength}function G(){return c.PRNG.stateLength}function N(){return c.PRNG.byteLength}function P(){return c.PRNG.state}function R(e){c.PRNG.state=e}}c.push("generic");var b=g();e(b,"factory",g);export{b as default,g as factory}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 4984bd1..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/factory.js","../lib/main.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 dtypes from '@stdlib/array-typed-real-float-dtypes';\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes();\nDTYPES.push( 'generic' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( 'null2h', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( DTYPES.indexOf( opts.dtype ) < 0 ) {\n\t\t\treturn new TypeError( format( 'null3t', 'dtype', DTYPES.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport setReadOnlyAccessor from '@stdlib/utils-define-nonenumerable-read-only-accessor';\nimport setReadWriteAccessor from '@stdlib/utils-define-nonenumerable-read-write-accessor';\nimport constantFunction from '@stdlib/utils-constant-function';\nimport noop from '@stdlib/utils-noop';\nimport base from '@stdlib/random-base-uniform';\nimport ctors from '@stdlib/array-typed-real-float-ctors';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport nullary from '@stdlib/strided-base-nullary';\nimport binary from '@stdlib/strided-base-binary';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution.\n*\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\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 {RangeError} `a` must be less than `b`\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 uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10 );\n* // returns \n*\n* @example\n* var uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nfunction factory() {\n\tvar options;\n\tvar nargs;\n\tvar opts;\n\tvar rand;\n\tvar prng;\n\tvar err;\n\n\topts = {\n\t\t'dtype': defaults.dtype\n\t};\n\n\tnargs = arguments.length;\n\tif ( nargs === 0 ) {\n\t\tprng = base;\n\t\trand = uniform2;\n\t} else if ( nargs === 1 ) {\n\t\toptions = arguments[ 0 ];\n\t\tprng = base.factory( options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform2;\n\t} else if ( nargs === 2 ) {\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ] );\n\t\trand = uniform1;\n\t} else if ( nargs === 3 ) {\n\t\toptions = arguments[ 2 ];\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ], options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform1;\n\t}\n\tif ( options && options.prng ) {\n\t\tsetReadOnly( rand, 'seed', null );\n\t\tsetReadOnly( rand, 'seedLength', null );\n\t\tsetReadWriteAccessor( rand, 'state', constantFunction( null ), noop );\n\t\tsetReadOnly( rand, 'stateLength', null );\n\t\tsetReadOnly( rand, 'byteLength', null );\n\t} else {\n\t\tsetReadOnlyAccessor( rand, 'seed', getSeed );\n\t\tsetReadOnlyAccessor( rand, 'seedLength', getSeedLength );\n\t\tsetReadWriteAccessor( rand, 'state', getState, setState );\n\t\tsetReadOnlyAccessor( rand, 'stateLength', getStateLength );\n\t\tsetReadOnlyAccessor( rand, 'byteLength', getStateSize );\n\t}\n\tsetReadOnly( rand, 'PRNG', prng.PRNG );\n\treturn rand;\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform1( len, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( 'null2p', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 1 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, prng );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tnullary( [ out ], [ len ], [ 1 ], prng );\n\t\treturn out;\n\t}\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {number} a - minimum support\n\t* @param {number} b - maximum support\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform2( len, a, b, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( 'null2p', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 3 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\t// NOTE: we could alternatively use the PRNG factory function to create a PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. Decision made here to avoid this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom number. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in a return value of `NaN`.\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, wrapper );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tbinary( [ [ a ], [ b ], out ], [ len ], [ 0, 0, 1 ], prng );\n\t\treturn out;\n\n\t\t/**\n\t\t* Applies parameters to a pseudorandom number generator function.\n\t\t*\n\t\t* @private\n\t\t* @returns {number} pseudorandom number\n\t\t*/\n\t\tfunction wrapper() {\n\t\t\treturn prng( a, b );\n\t\t}\n\t}\n\n\t/**\n\t* Returns the PRNG seed.\n\t*\n\t* @private\n\t* @returns {PRNGSeedMT19937} seed\n\t*/\n\tfunction getSeed() {\n\t\treturn rand.PRNG.seed;\n\t}\n\n\t/**\n\t* Returns the PRNG seed length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} seed length\n\t*/\n\tfunction getSeedLength() {\n\t\treturn rand.PRNG.seedLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state length\n\t*/\n\tfunction getStateLength() {\n\t\treturn rand.PRNG.stateLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state size (in bytes).\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state size (in bytes)\n\t*/\n\tfunction getStateSize() {\n\t\treturn rand.PRNG.byteLength;\n\t}\n\n\t/**\n\t* Returns the current pseudorandom number generator state.\n\t*\n\t* @private\n\t* @returns {PRNGStateMT19937} current state\n\t*/\n\tfunction getState() {\n\t\treturn rand.PRNG.state;\n\t}\n\n\t/**\n\t* Sets the pseudorandom number generator state.\n\t*\n\t* @private\n\t* @param {PRNGStateMT19937} s - generator state\n\t* @throws {Error} must provide a valid state\n\t*/\n\tfunction setState( s ) {\n\t\trand.PRNG.state = s;\n\t}\n}\n\n\n// EXPORTS //\n\nexport default factory;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @name uniform\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\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 = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar uniform = factory();\n\n\n// EXPORTS //\n\nexport default uniform;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @module @stdlib/random-array-uniform\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.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\" }\n"],"names":["DTYPES","dtypes","validate","opts","options","isObject","hasOwnProp","dtype","indexOf","TypeError","format","join","factory","nargs","rand","prng","err","defaults","arguments","length","base","uniform2","uniform1","setReadOnly","setReadWriteAccessor","constantFunction","noop","setReadOnlyAccessor","getSeed","getSeedLength","getState","setState","getStateLength","getStateSize","PRNG","len","out","dt","o","isNonNegativeInteger","filledBy","ctors","nullary","a","b","wrapper","binary","seed","seedLength","stateLength","byteLength","state","s","push","uniform","main"],"mappings":";;07CA8BIA,EAASC,IAyBb,SAASC,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,WACzBD,EAAKI,MAAQH,EAAQG,MAChBP,EAAOQ,QAASL,EAAKI,OAAU,GAC5B,IAAIE,UAAWC,EAAQ,SAAU,QAASV,EAAOW,KAAM,QAAUR,EAAKI,QAGxE,KARC,IAAIE,UAAWC,EAAQ,SAAUN,GAS1C,CCSA,SAASQ,IACR,IAAIR,EACAS,EACAV,EACAW,EACAC,EACAC,EAOJ,GALAb,EAAO,CACNI,MAASU,GAIK,KADfJ,EAAQK,UAAUC,QAEjBJ,EAAOK,EACPN,EAAOO,OACD,GAAe,IAAVR,EAAc,CAIzB,GAHAT,EAAUc,UAAW,GACrBH,EAAOK,EAAKR,QAASR,GACrBY,EAAMd,EAAUC,EAAMC,GAErB,MAAMY,EAEPF,EAAOO,CACT,MAAQ,GAAe,IAAVR,EACXE,EAAOK,EAAKR,QAASM,UAAW,GAAKA,UAAW,IAChDJ,EAAOQ,OACD,GAAe,IAAVT,EAAc,CAIzB,GAHAT,EAAUc,UAAW,GACrBH,EAAOK,EAAKR,QAASM,UAAW,GAAKA,UAAW,GAAKd,GACrDY,EAAMd,EAAUC,EAAMC,GAErB,MAAMY,EAEPF,EAAOQ,CACP,CAeD,OAdKlB,GAAWA,EAAQW,MACvBQ,EAAaT,EAAM,OAAQ,MAC3BS,EAAaT,EAAM,aAAc,MACjCU,EAAsBV,EAAM,QAASW,EAAkB,MAAQC,GAC/DH,EAAaT,EAAM,cAAe,MAClCS,EAAaT,EAAM,aAAc,QAEjCa,EAAqBb,EAAM,OAAQc,GACnCD,EAAqBb,EAAM,aAAce,GACzCL,EAAsBV,EAAM,QAASgB,EAAUC,GAC/CJ,EAAqBb,EAAM,cAAekB,GAC1CL,EAAqBb,EAAM,aAAcmB,IAE1CV,EAAaT,EAAM,OAAQC,EAAKmB,MACzBpB,EAcP,SAASQ,EAAUa,EAAK/B,GACvB,IACIgC,EACApB,EACAqB,EACAC,EACJ,IAAMC,EAAsBJ,GAC3B,MAAM,IAAI1B,UAAWC,EAAQ,SAAUyB,IAGxC,GADAG,EAAI,CAAA,EACCpB,UAAUC,OAAS,IACvBH,EAAMd,EAAUoC,EAAGlC,IAElB,MAAMY,EAIR,MAAY,aADZqB,EAAKC,EAAE/B,OAASJ,EAAKI,OAEbiC,EAAUL,EAAKpB,IAGvBqB,EAAM,IADCK,EAAOJ,GACR,CAAUF,GAChBO,EAAS,CAAEN,GAAO,CAAED,GAAO,CAAE,GAAKpB,GAC3BqB,EACP,CAgBD,SAASf,EAAUc,EAAKQ,EAAGC,EAAGxC,GAC7B,IACIgC,EACApB,EACAqB,EACAC,EACJ,IAAMC,EAAsBJ,GAC3B,MAAM,IAAI1B,UAAWC,EAAQ,SAAUyB,IAGxC,GADAG,EAAI,CAAA,EACCpB,UAAUC,OAAS,IACvBH,EAAMd,EAAUoC,EAAGlC,IAElB,MAAMY,EAKR,MAAY,aADZqB,EAAKC,EAAE/B,OAASJ,EAAKI,OAEbiC,EAAUL,EAAKU,IAGvBT,EAAM,IADCK,EAAOJ,GACR,CAAUF,GAChBW,EAAQ,CAAE,CAAEH,GAAK,CAAEC,GAAKR,GAAO,CAAED,GAAO,CAAE,EAAG,EAAG,GAAKpB,GAC9CqB,GAQP,SAASS,IACR,OAAO9B,EAAM4B,EAAGC,EAChB,CACD,CAQD,SAAShB,IACR,OAAOd,EAAKoB,KAAKa,IACjB,CAQD,SAASlB,IACR,OAAOf,EAAKoB,KAAKc,UACjB,CAQD,SAAShB,IACR,OAAOlB,EAAKoB,KAAKe,WACjB,CAQD,SAAShB,IACR,OAAOnB,EAAKoB,KAAKgB,UACjB,CAQD,SAASpB,IACR,OAAOhB,EAAKoB,KAAKiB,KACjB,CASD,SAASpB,EAAUqB,GAClBtC,EAAKoB,KAAKiB,MAAQC,CAClB,CACF,CDrPApD,EAAOqD,KAAM,WEqBV,IAACC,EAAU1C,ICiBdW,EAAAgC,EAAA,UAAA3C"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 1bbae74..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From e673a921c04afdd7b007dd89bc843a25135aefae Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 15 Feb 2023 10:30:47 +0000 Subject: [PATCH 17/82] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 62 - .github/workflows/cancel.yml | 56 - .github/workflows/close_pull_requests.yml | 44 - .github/workflows/examples.yml | 62 - .github/workflows/npm_downloads.yml | 108 - .github/workflows/productionize.yml | 798 --- .github/workflows/publish.yml | 236 - .github/workflows/test.yml | 97 - .github/workflows/test_bundles.yml | 180 - .github/workflows/test_coverage.yml | 123 - .github/workflows/test_install.yml | 83 - .gitignore | 188 - .npmignore | 227 - .npmrc | 28 - CHANGELOG.md | 5 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 61 +- benchmark/benchmark.float32.factory.js | 96 - benchmark/benchmark.float32.js | 98 - benchmark/benchmark.float64.factory.js | 96 - benchmark/benchmark.float64.js | 98 - benchmark/benchmark.generic.factory.js | 96 - benchmark/benchmark.generic.js | 98 - branches.md | 53 - docs/repl.txt | 192 - docs/types/test.ts | 355 -- examples/index.js | 48 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/defaults.json | 3 - lib/factory.js | 282 - lib/index.js | 77 - lib/main.js | 58 - lib/validate.js | 72 - package.json | 76 +- stats.html | 6177 +++++++++++++++++++++ test/test.factory.js | 1328 ----- test/test.js | 69 - test/test.main.js | 244 - test/test.validate.js | 118 - 47 files changed, 6215 insertions(+), 6662 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 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 benchmark/benchmark.float32.factory.js delete mode 100644 benchmark/benchmark.float32.js delete mode 100644 benchmark/benchmark.float64.factory.js delete mode 100644 benchmark/benchmark.float64.js delete mode 100644 benchmark/benchmark.generic.factory.js delete mode 100644 benchmark/benchmark.generic.js delete mode 100644 branches.md 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/defaults.json delete mode 100644 lib/factory.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/test.factory.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js delete mode 100644 test/test.validate.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 0fd4d6c..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 `tslint.json` files: -[tslint.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 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 c4ab52b..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/uniform) 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 06a9a75..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,62 +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' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 a00dbe5..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,56 +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' - uses: styfle/cancel-workflow-action@0.11.0 - 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 7eca213..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,44 +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: - run: - runs-on: ubuntu-latest - steps: - - uses: superbrothers/close-pull-request@v3 - 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/uniform) 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 7902a7d..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,62 +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 the repository: - - name: 'Checkout the repository' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 818b9df..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,108 +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: '33 9 * * 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' - uses: actions/checkout@v3 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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' - uses: actions/upload-artifact@v3 - 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' - uses: distributhor/workflow-webhook@v3 - 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 3e8e2db..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,798 +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' - uses: actions/checkout@v3 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 - - # Format error messages: - - name: 'Replace double quotes with single quotes in rewritten format string error messages' - run: | - find . -name "*.js" -exec sed -E -i "s/Error\( format\( \"([a-zA-Z0-9]+)\"/Error\( format\( '\1'/g" {} \; - - # Format string literal error messages: - - name: 'Replace double quotes with single quotes in rewritten string literal error messages' - run: | - find . -name "*.js" -exec sed -E -i "s/Error\( format\(\"([a-zA-Z0-9]+)\"\)/Error\( format\( '\1' \)/g" {} \; - - # Format code: - - name: 'Replace double quotes with single quotes in inserted `require` calls' - run: | - find . -name "*.js" -exec sed -E -i "s/require\( ?\"@stdlib\/error-tools-fmtprodmsg\" ?\);/require\( '@stdlib\/error-tools-fmtprodmsg' \);/g" {} \; - - # 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' }} - uses: actions/checkout@v3 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - uses: actions/setup-node@v3 - with: - node-version: 16 - 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' - uses: actions/checkout@v3 - - # 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' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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' - uses: act10ns/slack@v1 - 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' - uses: actions/checkout@v3 - - # 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' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 + + ```
@@ -364,7 +363,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]. @@ -424,13 +423,13 @@ Copyright © 2016-2023. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/random-array-uniform/main/LICENSE -[@stdlib/random/base/uniform]: https://github.com/stdlib-js/random-base-uniform +[@stdlib/random/base/uniform]: https://github.com/stdlib-js/random-base-uniform/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/benchmark/benchmark.float32.factory.js b/benchmark/benchmark.float32.factory.js deleted file mode 100644 index 67e61f4..0000000 --- a/benchmark/benchmark.float32.factory.js +++ /dev/null @@ -1,96 +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 bench = require( '@stdlib/bench' ); -var isnanf = require( '@stdlib/math-base-assert-is-nanf' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var fcn = uniform.factory( 2.0, 5.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 4642816..0000000 --- a/benchmark/benchmark.float32.js +++ /dev/null @@ -1,98 +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 bench = require( '@stdlib/bench' ); -var isnanf = require( '@stdlib/math-base-assert-is-nanf' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = 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 = uniform( len, 2.0, 5.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.factory.js b/benchmark/benchmark.float64.factory.js deleted file mode 100644 index 8646a54..0000000 --- a/benchmark/benchmark.float64.factory.js +++ /dev/null @@ -1,96 +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 bench = require( '@stdlib/bench' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var fcn = uniform.factory( 2.0, 5.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 5ee0d97..0000000 --- a/benchmark/benchmark.float64.js +++ /dev/null @@ -1,98 +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 bench = require( '@stdlib/bench' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = 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 = uniform( len, 2.0, 5.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.factory.js b/benchmark/benchmark.generic.factory.js deleted file mode 100644 index 7020d62..0000000 --- a/benchmark/benchmark.generic.factory.js +++ /dev/null @@ -1,96 +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 bench = require( '@stdlib/bench' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var fcn = uniform.factory( 2.0, 5.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 06a2a83..0000000 --- a/benchmark/benchmark.generic.js +++ /dev/null @@ -1,98 +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 bench = require( '@stdlib/bench' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = 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 = uniform( len, 2.0, 5.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 30542fb..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/uniform" -%% click B href "https://github.com/stdlib-js/random-array-uniform/tree/main" -%% click C href "https://github.com/stdlib-js/random-array-uniform/tree/production" -%% click D href "https://github.com/stdlib-js/random-array-uniform/tree/esm" -%% click E href "https://github.com/stdlib-js/random-array-uniform/tree/deno" -%% click F href "https://github.com/stdlib-js/random-array-uniform/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/uniform -[production-url]: https://github.com/stdlib-js/random-array-uniform/tree/production -[deno-url]: https://github.com/stdlib-js/random-array-uniform/tree/deno -[umd-url]: https://github.com/stdlib-js/random-array-uniform/tree/umd -[esm-url]: https://github.com/stdlib-js/random-array-uniform/tree/esm \ No newline at end of file diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 4b4e952..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,192 +0,0 @@ - -{{alias}}( len, a, b[, options] ) - Returns an array containing pseudorandom numbers drawn from a continuous - uniform distribution. - - Parameters - ---------- - len: integer - Output array length. - - a: number - Minimum support. - - b: number - Maximum support. - - 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) - Output array data type. Default: 'float64'. - - Returns - ------- - out: Array|Float64Array|Float32Array - Output array. - - Examples - -------- - > var out = {{alias}}( 3, 2.0, 5.0 ) - - - -{{alias}}.factory( [a, b, ][options] ) - Returns a function for creating arrays containing pseudorandom numbers drawn - from a continuous uniform distribution. - - If provided `a` and `b`, the returned function returns random variates drawn - from the specified distribution. - - If not provided `a` and `b`, the returned function requires that both `a` - and `b` 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. - - 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 ) - - - // Provide distribution parameters: - > fcn = {{alias}}.factory( 2.0, 5.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 ) - - - // Get a copy of the current state: - > var state = {{alias}}.state - - - > out = {{alias}}( 3, 2.0, 5.0 ) - - > out = {{alias}}( 3, 2.0, 5.0 ) - - - // Set the state: - > {{alias}}.state = state; - - // Regenerate a previous array: - > out = {{alias}}( 3, 2.0, 5.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 a087b98..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,355 +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. -*/ - -import random = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - random( 10, 2, 3 ); // $ExpectType RandomArray - random( 10, 1, 2 ); // $ExpectType RandomArray - random( 10, 1, 2, {} ); // $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 ); // $ExpectError - random( true, 2.0, 5.0 ); // $ExpectError - random( false, 2.0, 5.0 ); // $ExpectError - random( null, 2.0, 5.0 ); // $ExpectError - random( [], 2.0, 5.0 ); // $ExpectError - random( {}, 2.0, 5.0 ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - random( '5', 2.0, 5.0, {} ); // $ExpectError - random( true, 2.0, 5.0, {} ); // $ExpectError - random( false, 2.0, 5.0, {} ); // $ExpectError - random( null, 2.0, 5.0, {} ); // $ExpectError - random( [], 2.0, 5.0, {} ); // $ExpectError - random( {}, 2.0, 5.0, {} ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.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 ); // $ExpectError - random( 10, true, 5.0 ); // $ExpectError - random( 10, false, 5.0 ); // $ExpectError - random( 10, null, 5.0 ); // $ExpectError - random( 10, [], 5.0 ); // $ExpectError - random( 10, {}, 5.0 ); // $ExpectError - random( 10, ( x: number ): number => x, 5.0 ); // $ExpectError - - random( 10, '5', 5.0, {} ); // $ExpectError - random( 10, true, 5.0, {} ); // $ExpectError - random( 10, false, 5.0, {} ); // $ExpectError - random( 10, null, 5.0, {} ); // $ExpectError - random( 10, [], 5.0, {} ); // $ExpectError - random( 10, {}, 5.0, {} ); // $ExpectError - random( 10, ( x: number ): number => x, 5.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' ); // $ExpectError - random( 10, 2.0, true ); // $ExpectError - random( 10, 2.0, false ); // $ExpectError - random( 10, 2.0, null ); // $ExpectError - random( 10, 2.0, [] ); // $ExpectError - random( 10, 2.0, {} ); // $ExpectError - random( 10, 2.0, ( x: number ): number => x ); // $ExpectError - - random( 10, 2.0, '5', {} ); // $ExpectError - random( 10, 2.0, true, {} ); // $ExpectError - random( 10, 2.0, false, {} ); // $ExpectError - random( 10, 2.0, null, {} ); // $ExpectError - random( 10, 2.0, [], {} ); // $ExpectError - random( 10, 2.0, {}, {} ); // $ExpectError - random( 10, 2.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, '5' ); // $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, [] ); // $ExpectError - random( 10, 2.0, 5.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, { 'dtype': 123 } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': null } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - random( 10, 2.0, 5.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 -} - -// Attached to main export is a `factory` method which returns a function... -{ - random.factory( 2.0, 5.0 ); // $ExpectType UnaryFunction - random.factory( 2.0, 5.0, { 'copy': false } ); // $ExpectType UnaryFunction - - random.factory(); // $ExpectType TernaryFunction - random.factory( { 'copy': false } ); // $ExpectType TernaryFunction -} - -// The `factory` method returns a function which returns an array... -{ - const fcn1 = random.factory( 2.0, 5.0 ); - fcn1( 10 ); // $ExpectType RandomArray - - const fcn2 = random.factory(); - fcn2( 10, 2.0, 5.0 ); // $ExpectType RandomArray -} - -// The compiler throws an error if the `factory` method is provided invalid arguments... -{ - random.factory( '5', 5.0 ); // $ExpectError - random.factory( true, 5.0 ); // $ExpectError - random.factory( false, 5.0 ); // $ExpectError - random.factory( [], 5.0 ); // $ExpectError - random.factory( {}, 5.0 ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0 ); // $ExpectError - - random.factory( '5', 5.0, {} ); // $ExpectError - random.factory( true, 5.0, {} ); // $ExpectError - random.factory( false, 5.0, {} ); // $ExpectError - random.factory( [], 5.0, {} ); // $ExpectError - random.factory( {}, 5.0, {} ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0, {} ); // $ExpectError - - random.factory( 2.0, '5' ); // $ExpectError - random.factory( 2.0, true ); // $ExpectError - random.factory( 2.0, false ); // $ExpectError - random.factory( 2.0, [] ); // $ExpectError - random.factory( 2.0, {} ); // $ExpectError - random.factory( 2.0, ( x: number ): number => x ); // $ExpectError - - random.factory( 2.0, '5', {} ); // $ExpectError - random.factory( 2.0, true, {} ); // $ExpectError - random.factory( 2.0, false, {} ); // $ExpectError - random.factory( 2.0, [], {} ); // $ExpectError - random.factory( 2.0, {}, {} ); // $ExpectError - random.factory( 2.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, 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, { 'prng': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'seed': true } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': [ 'a' ] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'state': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': {} } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': true ); // $ExpectError - random.factory( 2.0, 5.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, { 'copy': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'dtype': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - random.factory( 2.0, 5.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, {}, {} ); // $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 ); - 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 ); // $ExpectError - fcn2( false, 2.0, 5.0 ); // $ExpectError - fcn2( '5', 2.0, 5.0 ); // $ExpectError - fcn2( [], 2.0, 5.0 ); // $ExpectError - fcn2( {}, 2.0, 5.0 ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - fcn2( true, 2.0, 5.0, {} ); // $ExpectError - fcn2( false, 2.0, 5.0, {} ); // $ExpectError - fcn2( '5', 2.0, 5.0, {} ); // $ExpectError - fcn2( [], 2.0, 5.0, {} ); // $ExpectError - fcn2( {}, 2.0, 5.0, {} ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0, {} ); // $ExpectError - - fcn2( 10, true, 5.0 ); // $ExpectError - fcn2( 10, false, 5.0 ); // $ExpectError - fcn2( 10, '5', 5.0 ); // $ExpectError - fcn2( 10, [], 5.0 ); // $ExpectError - fcn2( 10, {}, 5.0 ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0 ); // $ExpectError - - fcn2( 10, true, 5.0, {} ); // $ExpectError - fcn2( 10, false, 5.0, {} ); // $ExpectError - fcn2( 10, '5', 5.0, {} ); // $ExpectError - fcn2( 10, [], 5.0, {} ); // $ExpectError - fcn2( 10, {}, 5.0, {} ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0, {} ); // $ExpectError - - fcn2( 10, 2.0, true ); // $ExpectError - fcn2( 10, 2.0, false ); // $ExpectError - fcn2( 10, 2.0, '5' ); // $ExpectError - fcn2( 10, 2.0, [] ); // $ExpectError - fcn2( 10, 2.0, {} ); // $ExpectError - fcn2( 10, 2.0, ( x: number ): number => x ); // $ExpectError - - fcn2( 10, 2.0, true, {} ); // $ExpectError - fcn2( 10, 2.0, false, {} ); // $ExpectError - fcn2( 10, 2.0, '5', {} ); // $ExpectError - fcn2( 10, 2.0, [], {} ); // $ExpectError - fcn2( 10, 2.0, {}, {} ); // $ExpectError - fcn2( 10, 2.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, { 'dtype': 123 } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': null } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError - - const fcn2 = random.factory( 2.0, 5.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 ); - fcn1(); // $ExpectError - fcn1( 1, 1, 1 ); // $ExpectError - - const fcn2 = random.factory(); - fcn2(); // $ExpectError - fcn2( 1 ); // $ExpectError - fcn2( 1, 1, 1, 1 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index c485546..0000000 --- a/examples/index.js +++ /dev/null @@ -1,48 +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'; - -var logEach = require( '@stdlib/console-log-each' ); -var uniform = require( './../lib' ); - -// Create a function for generating random arrays originating from the same state: -var random = uniform.factory( 2.0, 5.0, { - 'state': uniform.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 = uniform.factory( 2.0, 5.0, { - 'state': uniform.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 d77d803..9b896f6 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 2.0 -/// +/// import { FloatDataType, 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..a4cb981 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-accessor@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-write-accessor@esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-constant-function@esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-noop@v0.0.14-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/random-base-uniform@esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-typed-real-float-ctors@esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-nullary@esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@esm/index.mjs";import f from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.0.2-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/array-typed-real-float-dtypes@esm/index.mjs";import h from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@esm/index.mjs";var u="float64",c=a();function y(e,t){return h(t)?j(t,"dtype")&&(e.dtype=t.dtype,c.indexOf(e.dtype)<0)?new TypeError(f("null3t","dtype",c.join('", "'),e.dtype)):null:new TypeError(f("null2h",t))}function g(){var a,h,j,c,g,b;if(j={dtype:u},0===(h=arguments.length))g=d,c=x;else if(1===h){if(a=arguments[0],g=d.factory(a),b=y(j,a))throw b;c=x}else if(2===h)g=d.factory(arguments[0],arguments[1]),c=v;else if(3===h){if(a=arguments[2],g=d.factory(arguments[0],arguments[1],a),b=y(j,a))throw b;c=v}return a&&a.prng?(e(c,"seed",null),e(c,"seedLength",null),s(c,"state",r(null),i),e(c,"stateLength",null),e(c,"byteLength",null)):(n(c,"seed",w),n(c,"seedLength",L),s(c,"state",P,R),n(c,"stateLength",G),n(c,"byteLength",N)),e(c,"PRNG",g.PRNG),c;function v(e,n){var s,r,i,d;if(!t(e))throw new TypeError(f("null2p",e));if(d={},arguments.length>1&&(r=y(d,n)))throw r;return"generic"===(i=d.dtype||j.dtype)?l(e,g):(s=new(o(i))(e),m([s],[e],[1],g),s)}function x(e,n,s,r){var i,d,m,a;if(!t(e))throw new TypeError(f("null2p",e));if(a={},arguments.length>3&&(d=y(a,r)))throw d;return"generic"===(m=a.dtype||j.dtype)?l(e,h):(i=new(o(m))(e),p([[n],[s],i],[e],[0,0,1],g),i);function h(){return g(n,s)}}function w(){return c.PRNG.seed}function L(){return c.PRNG.seedLength}function G(){return c.PRNG.stateLength}function N(){return c.PRNG.byteLength}function P(){return c.PRNG.state}function R(e){c.PRNG.state=e}}c.push("generic");var b=g();e(b,"factory",g);export{b as default,g as factory}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..4984bd1 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/factory.js","../lib/main.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 dtypes from '@stdlib/array-typed-real-float-dtypes';\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes();\nDTYPES.push( 'generic' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( 'null2h', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( DTYPES.indexOf( opts.dtype ) < 0 ) {\n\t\t\treturn new TypeError( format( 'null3t', 'dtype', DTYPES.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport setReadOnlyAccessor from '@stdlib/utils-define-nonenumerable-read-only-accessor';\nimport setReadWriteAccessor from '@stdlib/utils-define-nonenumerable-read-write-accessor';\nimport constantFunction from '@stdlib/utils-constant-function';\nimport noop from '@stdlib/utils-noop';\nimport base from '@stdlib/random-base-uniform';\nimport ctors from '@stdlib/array-typed-real-float-ctors';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport nullary from '@stdlib/strided-base-nullary';\nimport binary from '@stdlib/strided-base-binary';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution.\n*\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\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 {RangeError} `a` must be less than `b`\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 uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10 );\n* // returns \n*\n* @example\n* var uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nfunction factory() {\n\tvar options;\n\tvar nargs;\n\tvar opts;\n\tvar rand;\n\tvar prng;\n\tvar err;\n\n\topts = {\n\t\t'dtype': defaults.dtype\n\t};\n\n\tnargs = arguments.length;\n\tif ( nargs === 0 ) {\n\t\tprng = base;\n\t\trand = uniform2;\n\t} else if ( nargs === 1 ) {\n\t\toptions = arguments[ 0 ];\n\t\tprng = base.factory( options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform2;\n\t} else if ( nargs === 2 ) {\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ] );\n\t\trand = uniform1;\n\t} else if ( nargs === 3 ) {\n\t\toptions = arguments[ 2 ];\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ], options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform1;\n\t}\n\tif ( options && options.prng ) {\n\t\tsetReadOnly( rand, 'seed', null );\n\t\tsetReadOnly( rand, 'seedLength', null );\n\t\tsetReadWriteAccessor( rand, 'state', constantFunction( null ), noop );\n\t\tsetReadOnly( rand, 'stateLength', null );\n\t\tsetReadOnly( rand, 'byteLength', null );\n\t} else {\n\t\tsetReadOnlyAccessor( rand, 'seed', getSeed );\n\t\tsetReadOnlyAccessor( rand, 'seedLength', getSeedLength );\n\t\tsetReadWriteAccessor( rand, 'state', getState, setState );\n\t\tsetReadOnlyAccessor( rand, 'stateLength', getStateLength );\n\t\tsetReadOnlyAccessor( rand, 'byteLength', getStateSize );\n\t}\n\tsetReadOnly( rand, 'PRNG', prng.PRNG );\n\treturn rand;\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform1( len, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( 'null2p', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 1 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, prng );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tnullary( [ out ], [ len ], [ 1 ], prng );\n\t\treturn out;\n\t}\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {number} a - minimum support\n\t* @param {number} b - maximum support\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform2( len, a, b, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( 'null2p', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 3 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\t// NOTE: we could alternatively use the PRNG factory function to create a PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. Decision made here to avoid this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom number. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in a return value of `NaN`.\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, wrapper );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tbinary( [ [ a ], [ b ], out ], [ len ], [ 0, 0, 1 ], prng );\n\t\treturn out;\n\n\t\t/**\n\t\t* Applies parameters to a pseudorandom number generator function.\n\t\t*\n\t\t* @private\n\t\t* @returns {number} pseudorandom number\n\t\t*/\n\t\tfunction wrapper() {\n\t\t\treturn prng( a, b );\n\t\t}\n\t}\n\n\t/**\n\t* Returns the PRNG seed.\n\t*\n\t* @private\n\t* @returns {PRNGSeedMT19937} seed\n\t*/\n\tfunction getSeed() {\n\t\treturn rand.PRNG.seed;\n\t}\n\n\t/**\n\t* Returns the PRNG seed length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} seed length\n\t*/\n\tfunction getSeedLength() {\n\t\treturn rand.PRNG.seedLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state length\n\t*/\n\tfunction getStateLength() {\n\t\treturn rand.PRNG.stateLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state size (in bytes).\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state size (in bytes)\n\t*/\n\tfunction getStateSize() {\n\t\treturn rand.PRNG.byteLength;\n\t}\n\n\t/**\n\t* Returns the current pseudorandom number generator state.\n\t*\n\t* @private\n\t* @returns {PRNGStateMT19937} current state\n\t*/\n\tfunction getState() {\n\t\treturn rand.PRNG.state;\n\t}\n\n\t/**\n\t* Sets the pseudorandom number generator state.\n\t*\n\t* @private\n\t* @param {PRNGStateMT19937} s - generator state\n\t* @throws {Error} must provide a valid state\n\t*/\n\tfunction setState( s ) {\n\t\trand.PRNG.state = s;\n\t}\n}\n\n\n// EXPORTS //\n\nexport default factory;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @name uniform\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\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 = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar uniform = factory();\n\n\n// EXPORTS //\n\nexport default uniform;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @module @stdlib/random-array-uniform\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.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\" }\n"],"names":["DTYPES","dtypes","validate","opts","options","isObject","hasOwnProp","dtype","indexOf","TypeError","format","join","factory","nargs","rand","prng","err","defaults","arguments","length","base","uniform2","uniform1","setReadOnly","setReadWriteAccessor","constantFunction","noop","setReadOnlyAccessor","getSeed","getSeedLength","getState","setState","getStateLength","getStateSize","PRNG","len","out","dt","o","isNonNegativeInteger","filledBy","ctors","nullary","a","b","wrapper","binary","seed","seedLength","stateLength","byteLength","state","s","push","uniform","main"],"mappings":";;07CA8BIA,EAASC,IAyBb,SAASC,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,WACzBD,EAAKI,MAAQH,EAAQG,MAChBP,EAAOQ,QAASL,EAAKI,OAAU,GAC5B,IAAIE,UAAWC,EAAQ,SAAU,QAASV,EAAOW,KAAM,QAAUR,EAAKI,QAGxE,KARC,IAAIE,UAAWC,EAAQ,SAAUN,GAS1C,CCSA,SAASQ,IACR,IAAIR,EACAS,EACAV,EACAW,EACAC,EACAC,EAOJ,GALAb,EAAO,CACNI,MAASU,GAIK,KADfJ,EAAQK,UAAUC,QAEjBJ,EAAOK,EACPN,EAAOO,OACD,GAAe,IAAVR,EAAc,CAIzB,GAHAT,EAAUc,UAAW,GACrBH,EAAOK,EAAKR,QAASR,GACrBY,EAAMd,EAAUC,EAAMC,GAErB,MAAMY,EAEPF,EAAOO,CACT,MAAQ,GAAe,IAAVR,EACXE,EAAOK,EAAKR,QAASM,UAAW,GAAKA,UAAW,IAChDJ,EAAOQ,OACD,GAAe,IAAVT,EAAc,CAIzB,GAHAT,EAAUc,UAAW,GACrBH,EAAOK,EAAKR,QAASM,UAAW,GAAKA,UAAW,GAAKd,GACrDY,EAAMd,EAAUC,EAAMC,GAErB,MAAMY,EAEPF,EAAOQ,CACP,CAeD,OAdKlB,GAAWA,EAAQW,MACvBQ,EAAaT,EAAM,OAAQ,MAC3BS,EAAaT,EAAM,aAAc,MACjCU,EAAsBV,EAAM,QAASW,EAAkB,MAAQC,GAC/DH,EAAaT,EAAM,cAAe,MAClCS,EAAaT,EAAM,aAAc,QAEjCa,EAAqBb,EAAM,OAAQc,GACnCD,EAAqBb,EAAM,aAAce,GACzCL,EAAsBV,EAAM,QAASgB,EAAUC,GAC/CJ,EAAqBb,EAAM,cAAekB,GAC1CL,EAAqBb,EAAM,aAAcmB,IAE1CV,EAAaT,EAAM,OAAQC,EAAKmB,MACzBpB,EAcP,SAASQ,EAAUa,EAAK/B,GACvB,IACIgC,EACApB,EACAqB,EACAC,EACJ,IAAMC,EAAsBJ,GAC3B,MAAM,IAAI1B,UAAWC,EAAQ,SAAUyB,IAGxC,GADAG,EAAI,CAAA,EACCpB,UAAUC,OAAS,IACvBH,EAAMd,EAAUoC,EAAGlC,IAElB,MAAMY,EAIR,MAAY,aADZqB,EAAKC,EAAE/B,OAASJ,EAAKI,OAEbiC,EAAUL,EAAKpB,IAGvBqB,EAAM,IADCK,EAAOJ,GACR,CAAUF,GAChBO,EAAS,CAAEN,GAAO,CAAED,GAAO,CAAE,GAAKpB,GAC3BqB,EACP,CAgBD,SAASf,EAAUc,EAAKQ,EAAGC,EAAGxC,GAC7B,IACIgC,EACApB,EACAqB,EACAC,EACJ,IAAMC,EAAsBJ,GAC3B,MAAM,IAAI1B,UAAWC,EAAQ,SAAUyB,IAGxC,GADAG,EAAI,CAAA,EACCpB,UAAUC,OAAS,IACvBH,EAAMd,EAAUoC,EAAGlC,IAElB,MAAMY,EAKR,MAAY,aADZqB,EAAKC,EAAE/B,OAASJ,EAAKI,OAEbiC,EAAUL,EAAKU,IAGvBT,EAAM,IADCK,EAAOJ,GACR,CAAUF,GAChBW,EAAQ,CAAE,CAAEH,GAAK,CAAEC,GAAKR,GAAO,CAAED,GAAO,CAAE,EAAG,EAAG,GAAKpB,GAC9CqB,GAQP,SAASS,IACR,OAAO9B,EAAM4B,EAAGC,EAChB,CACD,CAQD,SAAShB,IACR,OAAOd,EAAKoB,KAAKa,IACjB,CAQD,SAASlB,IACR,OAAOf,EAAKoB,KAAKc,UACjB,CAQD,SAAShB,IACR,OAAOlB,EAAKoB,KAAKe,WACjB,CAQD,SAAShB,IACR,OAAOnB,EAAKoB,KAAKgB,UACjB,CAQD,SAASpB,IACR,OAAOhB,EAAKoB,KAAKiB,KACjB,CASD,SAASpB,EAAUqB,GAClBtC,EAAKoB,KAAKiB,MAAQC,CAClB,CACF,CDrPApD,EAAOqD,KAAM,WEqBV,IAACC,EAAU1C,ICiBdW,EAAAgC,EAAA,UAAA3C"} \ No newline at end of file diff --git a/lib/defaults.json b/lib/defaults.json deleted file mode 100644 index 83f4438..0000000 --- a/lib/defaults.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "dtype": "float64" -} diff --git a/lib/factory.js b/lib/factory.js deleted file mode 100644 index 9f232af..0000000 --- a/lib/factory.js +++ /dev/null @@ -1,282 +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 isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var setReadOnlyAccessor = require( '@stdlib/utils-define-nonenumerable-read-only-accessor' ); -var setReadWriteAccessor = require( '@stdlib/utils-define-nonenumerable-read-write-accessor' ); -var constantFunction = require( '@stdlib/utils-constant-function' ); -var noop = require( '@stdlib/utils-noop' ); -var base = require( '@stdlib/random-base-uniform' ); -var ctors = require( '@stdlib/array-typed-real-float-ctors' ); -var filledBy = require( '@stdlib/array-base-filled-by' ); -var nullary = require( '@stdlib/strided-base-nullary' ); -var binary = require( '@stdlib/strided-base-binary' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution. -* -* @param {number} [a] - minimum support -* @param {number} [b] - maximum support -* @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 {RangeError} `a` must be less than `b` -* @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 uniform = factory( 2.0, 5.0 ); -* // returns -* -* var arr = uniform( 10 ); -* // returns -* -* @example -* var uniform = factory( 2.0, 5.0 ); -* // returns -* -* var arr = uniform( 10, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -function factory() { - var options; - var nargs; - var opts; - var rand; - var prng; - var err; - - opts = { - 'dtype': defaults.dtype - }; - - nargs = arguments.length; - if ( nargs === 0 ) { - prng = base; - rand = uniform2; - } else if ( nargs === 1 ) { - options = arguments[ 0 ]; - prng = base.factory( options ); - err = validate( opts, options ); - if ( err ) { - throw err; - } - rand = uniform2; - } else if ( nargs === 2 ) { - prng = base.factory( arguments[ 0 ], arguments[ 1 ] ); - rand = uniform1; - } else if ( nargs === 3 ) { - options = arguments[ 2 ]; - prng = base.factory( arguments[ 0 ], arguments[ 1 ], options ); - err = validate( opts, options ); - if ( err ) { - throw err; - } - rand = uniform1; - } - if ( options && options.prng ) { - setReadOnly( rand, 'seed', null ); - setReadOnly( rand, 'seedLength', null ); - setReadWriteAccessor( rand, 'state', constantFunction( null ), noop ); - setReadOnly( rand, 'stateLength', null ); - setReadOnly( rand, 'byteLength', null ); - } else { - setReadOnlyAccessor( rand, 'seed', getSeed ); - setReadOnlyAccessor( rand, 'seedLength', getSeedLength ); - setReadWriteAccessor( rand, 'state', getState, setState ); - setReadOnlyAccessor( rand, 'stateLength', getStateLength ); - setReadOnlyAccessor( rand, 'byteLength', getStateSize ); - } - setReadOnly( rand, 'PRNG', prng.PRNG ); - return rand; - - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @private - * @param {NonNegativeInteger} len - array length - * @param {Options} [options] - function options - * @param {string} [options.dtype] - 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 - */ - function uniform1( len, options ) { - var ctor; - var out; - var err; - var dt; - var o; - if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( 'null2p', len ) ); - } - o = {}; - if ( arguments.length > 1 ) { - err = validate( o, options ); - if ( err ) { - throw err; - } - } - dt = o.dtype || opts.dtype; - if ( dt === 'generic' ) { - return filledBy( len, prng ); - } - ctor = ctors( dt ); - out = new ctor( len ); - nullary( [ out ], [ len ], [ 1 ], prng ); - return out; - } - - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @private - * @param {NonNegativeInteger} len - array length - * @param {number} a - minimum support - * @param {number} b - maximum support - * @param {Options} [options] - function options - * @param {string} [options.dtype] - 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 - */ - function uniform2( len, a, b, options ) { - var ctor; - var out; - var err; - var dt; - var o; - if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( 'null2p', len ) ); - } - o = {}; - if ( arguments.length > 3 ) { - err = validate( o, options ); - if ( err ) { - throw err; - } - } - // NOTE: we could alternatively use the PRNG factory function to create a PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. Decision made here to avoid this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom number. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in a return value of `NaN`. - dt = o.dtype || opts.dtype; - if ( dt === 'generic' ) { - return filledBy( len, wrapper ); - } - ctor = ctors( dt ); - out = new ctor( len ); - binary( [ [ a ], [ b ], out ], [ len ], [ 0, 0, 1 ], prng ); - return out; - - /** - * Applies parameters to a pseudorandom number generator function. - * - * @private - * @returns {number} pseudorandom number - */ - function wrapper() { - return prng( a, b ); - } - } - - /** - * Returns the PRNG seed. - * - * @private - * @returns {PRNGSeedMT19937} seed - */ - function getSeed() { - return rand.PRNG.seed; - } - - /** - * Returns the PRNG seed length. - * - * @private - * @returns {PositiveInteger} seed length - */ - function getSeedLength() { - return rand.PRNG.seedLength; - } - - /** - * Returns the PRNG state length. - * - * @private - * @returns {PositiveInteger} state length - */ - function getStateLength() { - return rand.PRNG.stateLength; - } - - /** - * Returns the PRNG state size (in bytes). - * - * @private - * @returns {PositiveInteger} state size (in bytes) - */ - function getStateSize() { - return rand.PRNG.byteLength; - } - - /** - * Returns the current pseudorandom number generator state. - * - * @private - * @returns {PRNGStateMT19937} current state - */ - function getState() { - return rand.PRNG.state; - } - - /** - * Sets the pseudorandom number generator state. - * - * @private - * @param {PRNGStateMT19937} s - generator state - * @throws {Error} must provide a valid state - */ - function setState( s ) { - rand.PRNG.state = s; - } -} - - -// EXPORTS // - -module.exports = factory; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 0077f00..0000000 --- a/lib/index.js +++ /dev/null @@ -1,77 +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'; - -/** -* Create an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. -* -* @module @stdlib/random-array-uniform -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var arr = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var arr = uniform( 10, 2.0, 5.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var rand = uniform.factory( 2.0, 5.0 ); -* // returns -* -* var arr = rand( 10 ); -* // returns -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var rand = uniform.factory( 2.0, 5.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" } diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index da0d9b1..0000000 --- a/lib/main.js +++ /dev/null @@ -1,58 +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 factory = require( './factory.js' ); - - -// MAIN // - -/** -* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. -* -* @name uniform -* @type {Function} -* @param {NonNegativeInteger} len - array length -* @param {number} a - minimum support -* @param {number} b - maximum support -* @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 = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var arr = uniform( 10, 2.0, 5.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -var uniform = factory(); - - -// EXPORTS // - -module.exports = uniform; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index 3629aaf..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,72 +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 dtypes = require( '@stdlib/array-typed-real-float-dtypes' ); -var isObject = require( '@stdlib/assert-is-plain-object' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// VARIABLES // - -var DTYPES = dtypes(); -DTYPES.push( 'generic' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Options} options - function options -* @param {string} [options.dtype] - output array data type -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var options = { -* 'dtype': 'float64' -* }; -* var err = validate( opts, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( 'null2h', options ) ); - } - if ( hasOwnProp( options, 'dtype' ) ) { - opts.dtype = options.dtype; - if ( DTYPES.indexOf( opts.dtype ) < 0 ) { - return new TypeError( format( 'null3t', 'dtype', DTYPES.join( '", "' ), opts.dtype ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index 8b6d28d..621da6a 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 continuous uniform 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,55 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-filled-by": "^0.0.2", - "@stdlib/array-typed-real-float-ctors": "^0.0.1", - "@stdlib/array-typed-real-float-dtypes": "^0.0.1", - "@stdlib/assert-has-own-property": "^0.0.7", - "@stdlib/assert-is-nonnegative-integer": "^0.0.7", - "@stdlib/assert-is-plain-object": "^0.0.7", - "@stdlib/random-base-uniform": "^0.0.6", - "@stdlib/strided-base-binary": "^0.0.8", - "@stdlib/strided-base-nullary": "^0.0.7", - "@stdlib/error-tools-fmtprodmsg": "^0.0.2", - "@stdlib/types": "^0.0.14", - "@stdlib/utils-constant-function": "^0.0.8", - "@stdlib/utils-define-nonenumerable-read-only-accessor": "^0.0.7", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.7", - "@stdlib/utils-define-nonenumerable-read-write-accessor": "^0.0.7", - "@stdlib/utils-noop": "^0.0.14" - }, - "devDependencies": { - "@stdlib/array-float32": "^0.0.6", - "@stdlib/array-float64": "^0.0.6", - "@stdlib/array-uint32": "^0.0.6", - "@stdlib/assert-is-uint32array": "^0.0.8", - "@stdlib/bench": "^0.0.12", - "@stdlib/console-log-each": "^0.0.2", - "@stdlib/constants-uint32-max": "^0.0.7", - "@stdlib/math-base-assert-is-nan": "^0.0.8", - "@stdlib/math-base-assert-is-nanf": "^0.0.8", - "@stdlib/math-base-special-pow": "^0.0.7", - "@stdlib/random-base-minstd": "^0.0.6", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdmath", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..042e51d --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/test.factory.js b/test/test.factory.js deleted file mode 100644 index a869e75..0000000 --- a/test/test.factory.js +++ /dev/null @@ -1,1328 +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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -tape( 'the function throws an error if the second distribution parameter is less than the first distribution parameter', function test( t ) { - var values; - var i; - - values = [ - [ 0.0, 0.0 ], - [ -2.0, -4.0 ], - [ 2.0, 1.0 ] - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( arr ) { - return function badValue() { - factory( arr[0], arr[1] ); - }; - } -}); - -tape( 'the function throws an error if the second distribution parameter is less than the first distribution parameter (options)', function test( t ) { - var values; - var i; - - values = [ - [ 0.0, 0.0 ], - [ -2.0, -4.0 ], - [ 2.0, 1.0 ] - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( arr ) { - return function badValue() { - factory( arr[0], arr[1], {} ); - }; - } -}); - -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, 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, { - '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, { - '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, { - '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, { - '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, { - '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, { - '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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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 ); - - 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 ); - - 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, { - '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 ); - - 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 ); - 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( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory(); - actual = random( 10, 2.0, 5.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( typeof actual[ i ], 'number', '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 ); - - 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 ); - - 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 ); - - 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 that generates `NaN` values if the first distribution parameter is greater than or equal to the second distribution parameter', function test( t ) { - var random; - var values; - var actual; - var i; - var j; - - random = factory(); - values = [ - [ 2.0, 1.0 ], - [ -3.0, -4.0 ], - [ 0.0, 0.0 ] - ]; - - for ( i = 0; i < values.length; i++ ) { - actual = random( 10, values[ i ][ 0 ], values[ i ][ 1 ] ); - for ( j = 0; j < actual.length; j++ ) { - t.strictEqual( isnan( actual[ j ] ), true, 'returns expected value when provided '+values[ 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, { - '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 ); - - 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, { - '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( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'float64' - }); - actual = random( 10, 2.0, 5.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( typeof actual[ i ], 'number', '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, { - '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( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'float32' - }); - actual = random( 10, 2.0, 5.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( typeof actual[ i ], 'number', '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, { - '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 ); - - 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, { - '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, { - '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 ); - - // 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, { - '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 ); - - // 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, { - '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 ); - - 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, { - 'prng': randu.normalized - }); - - randu = minstd.factory({ - 'seed': seed - }); - random2 = factory( 2.0, 5.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 ); - arr2 = random2( 10, 2.0, 5.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 c4fb6d3..0000000 --- a/test/test.js +++ /dev/null @@ -1,69 +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 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 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 37b0080..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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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, 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, { - '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 ); - - 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( typeof actual[ i ], 'number', '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, { - '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( typeof actual[ i ], 'number', '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, { - '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( typeof actual[ i ], 'number', '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, { - '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 ); - } - // Capture the current state: - state = random.state; - - // Move to a future state... - arr = random( 10, 2.0, 5.0 ); - for ( i = 0; i < 100; i++ ) { - random( 2, 2.0, 5.0 ); - } - // Set the state: - random.state = state; - - // Replay previously generated values: - t.deepEqual( random( 10, 2.0, 5.0 ), arr, 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.validate.js b/test/test.validate.js deleted file mode 100644 index c515526..0000000 --- a/test/test.validate.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 validate = require( './../lib/validate.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.equal( typeof validate, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function returns an error if provided an options argument which is not an object', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - void 0, - null, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, values[ i ] ); - t.equal( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided a `dtype` option which is not a supported data type', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - -5, - NaN, - true, - false, - void 0, - null, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, { - 'dtype': values[ i ] - }); - t.equal( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns null if all options are valid', function test( t ) { - var options; - var opts; - var err; - - options = { - 'dtype': 'float64' - }; - opts = {}; - err = validate( opts, options ); - - t.equal( err, null, 'returns null' ); - t.deepEqual( opts, options, 'sets option values' ); - - t.end(); -}); - -tape( 'the function ignores unrecognized/unsupported options', function test( t ) { - var options; - var opts; - var err; - - options = { - 'beep': true, - 'boop': 'bop' - }; - opts = {}; - err = validate( opts, options ); - - t.equal( err, null, 'returns null' ); - t.deepEqual( opts, {}, 'does not set any option values' ); - t.end(); -}); From 93892378bdf18bd6803161d7f7accdfd02ccb260 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 5 Mar 2023 09:48:18 +0000 Subject: [PATCH 18/82] Transform error messages --- lib/factory.js | 6 +++--- lib/validate.js | 6 +++--- package.json | 2 +- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/lib/factory.js b/lib/factory.js index 22ec236..9f232af 100644 --- a/lib/factory.js +++ b/lib/factory.js @@ -31,7 +31,7 @@ var ctors = require( '@stdlib/array-typed-real-float-ctors' ); var filledBy = require( '@stdlib/array-base-filled-by' ); var nullary = require( '@stdlib/strided-base-nullary' ); var binary = require( '@stdlib/strided-base-binary' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -144,7 +144,7 @@ function factory() { var dt; var o; if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) ); + throw new TypeError( format( 'null2p', len ) ); } o = {}; if ( arguments.length > 1 ) { @@ -184,7 +184,7 @@ function factory() { var dt; var o; if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) ); + throw new TypeError( format( 'null2p', len ) ); } o = {}; if ( arguments.length > 3 ) { diff --git a/lib/validate.js b/lib/validate.js index 40b9723..3629aaf 100644 --- a/lib/validate.js +++ b/lib/validate.js @@ -23,7 +23,7 @@ var dtypes = require( '@stdlib/array-typed-real-float-dtypes' ); var isObject = require( '@stdlib/assert-is-plain-object' ); var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // VARIABLES // @@ -55,12 +55,12 @@ DTYPES.push( 'generic' ); */ function validate( opts, options ) { if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); + return new TypeError( format( 'null2h', options ) ); } if ( hasOwnProp( options, 'dtype' ) ) { opts.dtype = options.dtype; if ( DTYPES.indexOf( opts.dtype ) < 0 ) { - return new TypeError( format( 'invalid option. `%s` option must be one of the following: "%s". Option: `%s`.', 'dtype', DTYPES.join( '", "' ), opts.dtype ) ); + return new TypeError( format( 'null3t', 'dtype', DTYPES.join( '", "' ), opts.dtype ) ); } } return null; diff --git a/package.json b/package.json index 486f4d2..8b6d28d 100644 --- a/package.json +++ b/package.json @@ -46,7 +46,7 @@ "@stdlib/random-base-uniform": "^0.0.6", "@stdlib/strided-base-binary": "^0.0.8", "@stdlib/strided-base-nullary": "^0.0.7", - "@stdlib/string-format": "^0.0.3", + "@stdlib/error-tools-fmtprodmsg": "^0.0.2", "@stdlib/types": "^0.0.14", "@stdlib/utils-constant-function": "^0.0.8", "@stdlib/utils-define-nonenumerable-read-only-accessor": "^0.0.7", From 10ec6e848301eb7f839bd8a396153b9acbd42fcb Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 5 Mar 2023 10:07:33 +0000 Subject: [PATCH 19/82] Remove files --- index.d.ts | 245 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6427 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 9b896f6..0000000 --- a/index.d.ts +++ /dev/null @@ -1,245 +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. -*/ - -// TypeScript Version: 2.0 - -/// - -import { FloatDataType, FloatTypedArray } from '@stdlib/types/array'; -import * as random from '@stdlib/types/random'; - -/** -* Supported data types. -*/ -type DataType = FloatDataType | 'generic'; - -/** -* 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 continuous uniform distribution with pre-specified parameter values. -*/ -interface UnaryFunction extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @param len - array length - * @param options - function options - * @returns output array - */ - ( len: number, options?: Options ): RandomArray; -} - -/** -* Interface for generating pseudorandom numbers drawn from a continuous uniform distribution without pre-specified parameter values. -*/ -interface TernaryFunction extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @param len - array length - * @param a - minimum support - * @param b - maximum support - * @param options - function options - * @returns output array - */ - ( len: number, a: number, b: number, options?: Options ): RandomArray; -} - -/** -* Interface for generating pseudorandom numbers drawn from a uniform distribution. -*/ -interface Random extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @param len - array length - * @param a - minimum support - * @param b - maximum support - * @param options - function options - * @returns output array - * - * @example - * var out = uniform( 10, 2.0, 5.0 ); - * // returns - */ - ( len: number, a: number, b: number, options?: Options ): RandomArray; - - /** - * Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution. - * - * ## Notes - * - * - When provided `a` and `b`, the returned function returns random variates drawn from the specified distribution. - * - * @param a - minimum support - * @param b - maximum support - * @param options - function options - * @throws `a` must be less than `b` - * @throws must provide a valid state - * @returns function for creating arrays - * - * @example - * var random = uniform.factory( 2.0, 5.0 ); - * - * var out = random( 10 ); - * // returns - * - * @example - * var random = uniform.factory( 2.0, 5.0, { - * 'seed': 297 - * }); - * var out = random( 10 ); - * // returns - */ - factory( a: number, b: number, options?: FactoryOptions ): UnaryFunction; - - /** - * Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution. - * - * ## Notes - * - * - When not provided `a` and `b`, the returned function requires that both `a` and `b` be provided at each invocation. - * - * @param options - function options - * @throws must provide a valid state - * @returns function for creating arrays - * - * @example - * var random = uniform.factory(); - * - * var out = random( 10, 2.0, 5.0 ); - * // returns - * - * @example - * var random = uniform.factory({ - * 'seed': 297 - * }); - * var out = random( 10, 2.0, 5.0 ); - * // returns - */ - factory( options?: FactoryOptions ): TernaryFunction; -} - -/** -* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. -* -* @param len - array length -* @param a - minimum support -* @param b - maximum support -* @param options - function options -* @returns output array -* -* @example -* var out = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var random = uniform.factory( 2.0, 5.0 ); -* -* var out = random( 10 ); -* // returns -*/ -declare var uniform: Random; - - -// EXPORTS // - -export = uniform; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index a4cb981..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-accessor@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-write-accessor@esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-constant-function@esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-noop@v0.0.14-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/random-base-uniform@esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-typed-real-float-ctors@esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-nullary@esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@esm/index.mjs";import f from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.0.2-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/array-typed-real-float-dtypes@esm/index.mjs";import h from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@esm/index.mjs";var u="float64",c=a();function y(e,t){return h(t)?j(t,"dtype")&&(e.dtype=t.dtype,c.indexOf(e.dtype)<0)?new TypeError(f("null3t","dtype",c.join('", "'),e.dtype)):null:new TypeError(f("null2h",t))}function g(){var a,h,j,c,g,b;if(j={dtype:u},0===(h=arguments.length))g=d,c=x;else if(1===h){if(a=arguments[0],g=d.factory(a),b=y(j,a))throw b;c=x}else if(2===h)g=d.factory(arguments[0],arguments[1]),c=v;else if(3===h){if(a=arguments[2],g=d.factory(arguments[0],arguments[1],a),b=y(j,a))throw b;c=v}return a&&a.prng?(e(c,"seed",null),e(c,"seedLength",null),s(c,"state",r(null),i),e(c,"stateLength",null),e(c,"byteLength",null)):(n(c,"seed",w),n(c,"seedLength",L),s(c,"state",P,R),n(c,"stateLength",G),n(c,"byteLength",N)),e(c,"PRNG",g.PRNG),c;function v(e,n){var s,r,i,d;if(!t(e))throw new TypeError(f("null2p",e));if(d={},arguments.length>1&&(r=y(d,n)))throw r;return"generic"===(i=d.dtype||j.dtype)?l(e,g):(s=new(o(i))(e),m([s],[e],[1],g),s)}function x(e,n,s,r){var i,d,m,a;if(!t(e))throw new TypeError(f("null2p",e));if(a={},arguments.length>3&&(d=y(a,r)))throw d;return"generic"===(m=a.dtype||j.dtype)?l(e,h):(i=new(o(m))(e),p([[n],[s],i],[e],[0,0,1],g),i);function h(){return g(n,s)}}function w(){return c.PRNG.seed}function L(){return c.PRNG.seedLength}function G(){return c.PRNG.stateLength}function N(){return c.PRNG.byteLength}function P(){return c.PRNG.state}function R(e){c.PRNG.state=e}}c.push("generic");var b=g();e(b,"factory",g);export{b as default,g as factory}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 4984bd1..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/factory.js","../lib/main.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 dtypes from '@stdlib/array-typed-real-float-dtypes';\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes();\nDTYPES.push( 'generic' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( 'null2h', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( DTYPES.indexOf( opts.dtype ) < 0 ) {\n\t\t\treturn new TypeError( format( 'null3t', 'dtype', DTYPES.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport setReadOnlyAccessor from '@stdlib/utils-define-nonenumerable-read-only-accessor';\nimport setReadWriteAccessor from '@stdlib/utils-define-nonenumerable-read-write-accessor';\nimport constantFunction from '@stdlib/utils-constant-function';\nimport noop from '@stdlib/utils-noop';\nimport base from '@stdlib/random-base-uniform';\nimport ctors from '@stdlib/array-typed-real-float-ctors';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport nullary from '@stdlib/strided-base-nullary';\nimport binary from '@stdlib/strided-base-binary';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution.\n*\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\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 {RangeError} `a` must be less than `b`\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 uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10 );\n* // returns \n*\n* @example\n* var uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nfunction factory() {\n\tvar options;\n\tvar nargs;\n\tvar opts;\n\tvar rand;\n\tvar prng;\n\tvar err;\n\n\topts = {\n\t\t'dtype': defaults.dtype\n\t};\n\n\tnargs = arguments.length;\n\tif ( nargs === 0 ) {\n\t\tprng = base;\n\t\trand = uniform2;\n\t} else if ( nargs === 1 ) {\n\t\toptions = arguments[ 0 ];\n\t\tprng = base.factory( options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform2;\n\t} else if ( nargs === 2 ) {\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ] );\n\t\trand = uniform1;\n\t} else if ( nargs === 3 ) {\n\t\toptions = arguments[ 2 ];\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ], options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform1;\n\t}\n\tif ( options && options.prng ) {\n\t\tsetReadOnly( rand, 'seed', null );\n\t\tsetReadOnly( rand, 'seedLength', null );\n\t\tsetReadWriteAccessor( rand, 'state', constantFunction( null ), noop );\n\t\tsetReadOnly( rand, 'stateLength', null );\n\t\tsetReadOnly( rand, 'byteLength', null );\n\t} else {\n\t\tsetReadOnlyAccessor( rand, 'seed', getSeed );\n\t\tsetReadOnlyAccessor( rand, 'seedLength', getSeedLength );\n\t\tsetReadWriteAccessor( rand, 'state', getState, setState );\n\t\tsetReadOnlyAccessor( rand, 'stateLength', getStateLength );\n\t\tsetReadOnlyAccessor( rand, 'byteLength', getStateSize );\n\t}\n\tsetReadOnly( rand, 'PRNG', prng.PRNG );\n\treturn rand;\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform1( len, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( 'null2p', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 1 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, prng );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tnullary( [ out ], [ len ], [ 1 ], prng );\n\t\treturn out;\n\t}\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {number} a - minimum support\n\t* @param {number} b - maximum support\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform2( len, a, b, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( 'null2p', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 3 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\t// NOTE: we could alternatively use the PRNG factory function to create a PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. Decision made here to avoid this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom number. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in a return value of `NaN`.\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, wrapper );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tbinary( [ [ a ], [ b ], out ], [ len ], [ 0, 0, 1 ], prng );\n\t\treturn out;\n\n\t\t/**\n\t\t* Applies parameters to a pseudorandom number generator function.\n\t\t*\n\t\t* @private\n\t\t* @returns {number} pseudorandom number\n\t\t*/\n\t\tfunction wrapper() {\n\t\t\treturn prng( a, b );\n\t\t}\n\t}\n\n\t/**\n\t* Returns the PRNG seed.\n\t*\n\t* @private\n\t* @returns {PRNGSeedMT19937} seed\n\t*/\n\tfunction getSeed() {\n\t\treturn rand.PRNG.seed;\n\t}\n\n\t/**\n\t* Returns the PRNG seed length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} seed length\n\t*/\n\tfunction getSeedLength() {\n\t\treturn rand.PRNG.seedLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state length\n\t*/\n\tfunction getStateLength() {\n\t\treturn rand.PRNG.stateLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state size (in bytes).\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state size (in bytes)\n\t*/\n\tfunction getStateSize() {\n\t\treturn rand.PRNG.byteLength;\n\t}\n\n\t/**\n\t* Returns the current pseudorandom number generator state.\n\t*\n\t* @private\n\t* @returns {PRNGStateMT19937} current state\n\t*/\n\tfunction getState() {\n\t\treturn rand.PRNG.state;\n\t}\n\n\t/**\n\t* Sets the pseudorandom number generator state.\n\t*\n\t* @private\n\t* @param {PRNGStateMT19937} s - generator state\n\t* @throws {Error} must provide a valid state\n\t*/\n\tfunction setState( s ) {\n\t\trand.PRNG.state = s;\n\t}\n}\n\n\n// EXPORTS //\n\nexport default factory;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @name uniform\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\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 = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar uniform = factory();\n\n\n// EXPORTS //\n\nexport default uniform;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @module @stdlib/random-array-uniform\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.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\" }\n"],"names":["DTYPES","dtypes","validate","opts","options","isObject","hasOwnProp","dtype","indexOf","TypeError","format","join","factory","nargs","rand","prng","err","defaults","arguments","length","base","uniform2","uniform1","setReadOnly","setReadWriteAccessor","constantFunction","noop","setReadOnlyAccessor","getSeed","getSeedLength","getState","setState","getStateLength","getStateSize","PRNG","len","out","dt","o","isNonNegativeInteger","filledBy","ctors","nullary","a","b","wrapper","binary","seed","seedLength","stateLength","byteLength","state","s","push","uniform","main"],"mappings":";;07CA8BIA,EAASC,IAyBb,SAASC,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,WACzBD,EAAKI,MAAQH,EAAQG,MAChBP,EAAOQ,QAASL,EAAKI,OAAU,GAC5B,IAAIE,UAAWC,EAAQ,SAAU,QAASV,EAAOW,KAAM,QAAUR,EAAKI,QAGxE,KARC,IAAIE,UAAWC,EAAQ,SAAUN,GAS1C,CCSA,SAASQ,IACR,IAAIR,EACAS,EACAV,EACAW,EACAC,EACAC,EAOJ,GALAb,EAAO,CACNI,MAASU,GAIK,KADfJ,EAAQK,UAAUC,QAEjBJ,EAAOK,EACPN,EAAOO,OACD,GAAe,IAAVR,EAAc,CAIzB,GAHAT,EAAUc,UAAW,GACrBH,EAAOK,EAAKR,QAASR,GACrBY,EAAMd,EAAUC,EAAMC,GAErB,MAAMY,EAEPF,EAAOO,CACT,MAAQ,GAAe,IAAVR,EACXE,EAAOK,EAAKR,QAASM,UAAW,GAAKA,UAAW,IAChDJ,EAAOQ,OACD,GAAe,IAAVT,EAAc,CAIzB,GAHAT,EAAUc,UAAW,GACrBH,EAAOK,EAAKR,QAASM,UAAW,GAAKA,UAAW,GAAKd,GACrDY,EAAMd,EAAUC,EAAMC,GAErB,MAAMY,EAEPF,EAAOQ,CACP,CAeD,OAdKlB,GAAWA,EAAQW,MACvBQ,EAAaT,EAAM,OAAQ,MAC3BS,EAAaT,EAAM,aAAc,MACjCU,EAAsBV,EAAM,QAASW,EAAkB,MAAQC,GAC/DH,EAAaT,EAAM,cAAe,MAClCS,EAAaT,EAAM,aAAc,QAEjCa,EAAqBb,EAAM,OAAQc,GACnCD,EAAqBb,EAAM,aAAce,GACzCL,EAAsBV,EAAM,QAASgB,EAAUC,GAC/CJ,EAAqBb,EAAM,cAAekB,GAC1CL,EAAqBb,EAAM,aAAcmB,IAE1CV,EAAaT,EAAM,OAAQC,EAAKmB,MACzBpB,EAcP,SAASQ,EAAUa,EAAK/B,GACvB,IACIgC,EACApB,EACAqB,EACAC,EACJ,IAAMC,EAAsBJ,GAC3B,MAAM,IAAI1B,UAAWC,EAAQ,SAAUyB,IAGxC,GADAG,EAAI,CAAA,EACCpB,UAAUC,OAAS,IACvBH,EAAMd,EAAUoC,EAAGlC,IAElB,MAAMY,EAIR,MAAY,aADZqB,EAAKC,EAAE/B,OAASJ,EAAKI,OAEbiC,EAAUL,EAAKpB,IAGvBqB,EAAM,IADCK,EAAOJ,GACR,CAAUF,GAChBO,EAAS,CAAEN,GAAO,CAAED,GAAO,CAAE,GAAKpB,GAC3BqB,EACP,CAgBD,SAASf,EAAUc,EAAKQ,EAAGC,EAAGxC,GAC7B,IACIgC,EACApB,EACAqB,EACAC,EACJ,IAAMC,EAAsBJ,GAC3B,MAAM,IAAI1B,UAAWC,EAAQ,SAAUyB,IAGxC,GADAG,EAAI,CAAA,EACCpB,UAAUC,OAAS,IACvBH,EAAMd,EAAUoC,EAAGlC,IAElB,MAAMY,EAKR,MAAY,aADZqB,EAAKC,EAAE/B,OAASJ,EAAKI,OAEbiC,EAAUL,EAAKU,IAGvBT,EAAM,IADCK,EAAOJ,GACR,CAAUF,GAChBW,EAAQ,CAAE,CAAEH,GAAK,CAAEC,GAAKR,GAAO,CAAED,GAAO,CAAE,EAAG,EAAG,GAAKpB,GAC9CqB,GAQP,SAASS,IACR,OAAO9B,EAAM4B,EAAGC,EAChB,CACD,CAQD,SAAShB,IACR,OAAOd,EAAKoB,KAAKa,IACjB,CAQD,SAASlB,IACR,OAAOf,EAAKoB,KAAKc,UACjB,CAQD,SAAShB,IACR,OAAOlB,EAAKoB,KAAKe,WACjB,CAQD,SAAShB,IACR,OAAOnB,EAAKoB,KAAKgB,UACjB,CAQD,SAASpB,IACR,OAAOhB,EAAKoB,KAAKiB,KACjB,CASD,SAASpB,EAAUqB,GAClBtC,EAAKoB,KAAKiB,MAAQC,CAClB,CACF,CDrPApD,EAAOqD,KAAM,WEqBV,IAACC,EAAU1C,ICiBdW,EAAAgC,EAAA,UAAA3C"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 042e51d..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From bec34647e9700689e8664e8b32bcce0378450a79 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 5 Mar 2023 10:08:21 +0000 Subject: [PATCH 20/82] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 62 - .github/workflows/cancel.yml | 56 - .github/workflows/close_pull_requests.yml | 44 - .github/workflows/examples.yml | 62 - .github/workflows/npm_downloads.yml | 108 - .github/workflows/productionize.yml | 798 --- .github/workflows/publish.yml | 236 - .github/workflows/test.yml | 97 - .github/workflows/test_bundles.yml | 180 - .github/workflows/test_coverage.yml | 123 - .github/workflows/test_install.yml | 83 - .gitignore | 188 - .npmignore | 227 - .npmrc | 28 - CHANGELOG.md | 5 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 61 +- benchmark/benchmark.float32.factory.js | 96 - benchmark/benchmark.float32.js | 98 - benchmark/benchmark.float64.factory.js | 96 - benchmark/benchmark.float64.js | 98 - benchmark/benchmark.generic.factory.js | 96 - benchmark/benchmark.generic.js | 98 - branches.md | 53 - docs/repl.txt | 169 - docs/types/test.ts | 355 -- examples/index.js | 48 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/defaults.json | 3 - lib/factory.js | 282 - lib/index.js | 77 - lib/main.js | 58 - lib/validate.js | 72 - package.json | 76 +- stats.html | 6177 +++++++++++++++++++++ test/test.factory.js | 1328 ----- test/test.js | 69 - test/test.main.js | 244 - test/test.validate.js | 118 - 47 files changed, 6215 insertions(+), 6639 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 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 benchmark/benchmark.float32.factory.js delete mode 100644 benchmark/benchmark.float32.js delete mode 100644 benchmark/benchmark.float64.factory.js delete mode 100644 benchmark/benchmark.float64.js delete mode 100644 benchmark/benchmark.generic.factory.js delete mode 100644 benchmark/benchmark.generic.js delete mode 100644 branches.md 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/defaults.json delete mode 100644 lib/factory.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/test.factory.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js delete mode 100644 test/test.validate.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 0fd4d6c..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 `tslint.json` files: -[tslint.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 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 c4ab52b..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/uniform) 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 06a9a75..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,62 +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' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 a00dbe5..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,56 +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' - uses: styfle/cancel-workflow-action@0.11.0 - 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 7eca213..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,44 +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: - run: - runs-on: ubuntu-latest - steps: - - uses: superbrothers/close-pull-request@v3 - 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/uniform) 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 7902a7d..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,62 +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 the repository: - - name: 'Checkout the repository' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 818b9df..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,108 +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: '33 9 * * 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' - uses: actions/checkout@v3 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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' - uses: actions/upload-artifact@v3 - 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' - uses: distributhor/workflow-webhook@v3 - 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 3e8e2db..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,798 +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' - uses: actions/checkout@v3 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 - - # Format error messages: - - name: 'Replace double quotes with single quotes in rewritten format string error messages' - run: | - find . -name "*.js" -exec sed -E -i "s/Error\( format\( \"([a-zA-Z0-9]+)\"/Error\( format\( '\1'/g" {} \; - - # Format string literal error messages: - - name: 'Replace double quotes with single quotes in rewritten string literal error messages' - run: | - find . -name "*.js" -exec sed -E -i "s/Error\( format\(\"([a-zA-Z0-9]+)\"\)/Error\( format\( '\1' \)/g" {} \; - - # Format code: - - name: 'Replace double quotes with single quotes in inserted `require` calls' - run: | - find . -name "*.js" -exec sed -E -i "s/require\( ?\"@stdlib\/error-tools-fmtprodmsg\" ?\);/require\( '@stdlib\/error-tools-fmtprodmsg' \);/g" {} \; - - # 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' }} - uses: actions/checkout@v3 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - uses: actions/setup-node@v3 - with: - node-version: 16 - 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' - uses: actions/checkout@v3 - - # 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' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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' - uses: act10ns/slack@v1 - 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' - uses: actions/checkout@v3 - - # 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' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 + + ```
@@ -364,7 +363,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]. @@ -424,13 +423,13 @@ Copyright © 2016-2023. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/random-array-uniform/main/LICENSE -[@stdlib/random/base/uniform]: https://github.com/stdlib-js/random-base-uniform +[@stdlib/random/base/uniform]: https://github.com/stdlib-js/random-base-uniform/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/benchmark/benchmark.float32.factory.js b/benchmark/benchmark.float32.factory.js deleted file mode 100644 index 67e61f4..0000000 --- a/benchmark/benchmark.float32.factory.js +++ /dev/null @@ -1,96 +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 bench = require( '@stdlib/bench' ); -var isnanf = require( '@stdlib/math-base-assert-is-nanf' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var fcn = uniform.factory( 2.0, 5.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 4642816..0000000 --- a/benchmark/benchmark.float32.js +++ /dev/null @@ -1,98 +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 bench = require( '@stdlib/bench' ); -var isnanf = require( '@stdlib/math-base-assert-is-nanf' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = 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 = uniform( len, 2.0, 5.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.factory.js b/benchmark/benchmark.float64.factory.js deleted file mode 100644 index 8646a54..0000000 --- a/benchmark/benchmark.float64.factory.js +++ /dev/null @@ -1,96 +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 bench = require( '@stdlib/bench' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var fcn = uniform.factory( 2.0, 5.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 5ee0d97..0000000 --- a/benchmark/benchmark.float64.js +++ /dev/null @@ -1,98 +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 bench = require( '@stdlib/bench' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = 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 = uniform( len, 2.0, 5.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.factory.js b/benchmark/benchmark.generic.factory.js deleted file mode 100644 index 7020d62..0000000 --- a/benchmark/benchmark.generic.factory.js +++ /dev/null @@ -1,96 +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 bench = require( '@stdlib/bench' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var fcn = uniform.factory( 2.0, 5.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 06a2a83..0000000 --- a/benchmark/benchmark.generic.js +++ /dev/null @@ -1,98 +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 bench = require( '@stdlib/bench' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = 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 = uniform( len, 2.0, 5.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 30542fb..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/uniform" -%% click B href "https://github.com/stdlib-js/random-array-uniform/tree/main" -%% click C href "https://github.com/stdlib-js/random-array-uniform/tree/production" -%% click D href "https://github.com/stdlib-js/random-array-uniform/tree/esm" -%% click E href "https://github.com/stdlib-js/random-array-uniform/tree/deno" -%% click F href "https://github.com/stdlib-js/random-array-uniform/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/uniform -[production-url]: https://github.com/stdlib-js/random-array-uniform/tree/production -[deno-url]: https://github.com/stdlib-js/random-array-uniform/tree/deno -[umd-url]: https://github.com/stdlib-js/random-array-uniform/tree/umd -[esm-url]: https://github.com/stdlib-js/random-array-uniform/tree/esm \ No newline at end of file diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 256216a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,169 +0,0 @@ - -{{alias}}( len, a, b[, options] ) - Returns an array containing pseudorandom numbers drawn from a continuous - uniform distribution. - - Parameters - ---------- - len: integer - Output array length. - - a: number - Minimum support. - - b: number - Maximum support. - - 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 ) - - - -{{alias}}.factory( [a, b, ][options] ) - Returns a function for creating arrays containing pseudorandom numbers drawn - from a continuous uniform distribution. - - If provided `a` and `b`, the returned function returns random variates drawn - from the specified distribution. - - If not provided `a` and `b`, the returned function requires that both `a` - and `b` 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. - - 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 ) - - - // Provide distribution parameters: - > fcn = {{alias}}.factory( 2.0, 5.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 ) - - - // Get a copy of the current state: - > var state = {{alias}}.state - - - > out = {{alias}}( 3, 2.0, 5.0 ) - - > out = {{alias}}( 3, 2.0, 5.0 ) - - - // Set the state: - > {{alias}}.state = state; - - // Regenerate a previous array: - > out = {{alias}}( 3, 2.0, 5.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 a087b98..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,355 +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. -*/ - -import random = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - random( 10, 2, 3 ); // $ExpectType RandomArray - random( 10, 1, 2 ); // $ExpectType RandomArray - random( 10, 1, 2, {} ); // $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 ); // $ExpectError - random( true, 2.0, 5.0 ); // $ExpectError - random( false, 2.0, 5.0 ); // $ExpectError - random( null, 2.0, 5.0 ); // $ExpectError - random( [], 2.0, 5.0 ); // $ExpectError - random( {}, 2.0, 5.0 ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - random( '5', 2.0, 5.0, {} ); // $ExpectError - random( true, 2.0, 5.0, {} ); // $ExpectError - random( false, 2.0, 5.0, {} ); // $ExpectError - random( null, 2.0, 5.0, {} ); // $ExpectError - random( [], 2.0, 5.0, {} ); // $ExpectError - random( {}, 2.0, 5.0, {} ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.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 ); // $ExpectError - random( 10, true, 5.0 ); // $ExpectError - random( 10, false, 5.0 ); // $ExpectError - random( 10, null, 5.0 ); // $ExpectError - random( 10, [], 5.0 ); // $ExpectError - random( 10, {}, 5.0 ); // $ExpectError - random( 10, ( x: number ): number => x, 5.0 ); // $ExpectError - - random( 10, '5', 5.0, {} ); // $ExpectError - random( 10, true, 5.0, {} ); // $ExpectError - random( 10, false, 5.0, {} ); // $ExpectError - random( 10, null, 5.0, {} ); // $ExpectError - random( 10, [], 5.0, {} ); // $ExpectError - random( 10, {}, 5.0, {} ); // $ExpectError - random( 10, ( x: number ): number => x, 5.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' ); // $ExpectError - random( 10, 2.0, true ); // $ExpectError - random( 10, 2.0, false ); // $ExpectError - random( 10, 2.0, null ); // $ExpectError - random( 10, 2.0, [] ); // $ExpectError - random( 10, 2.0, {} ); // $ExpectError - random( 10, 2.0, ( x: number ): number => x ); // $ExpectError - - random( 10, 2.0, '5', {} ); // $ExpectError - random( 10, 2.0, true, {} ); // $ExpectError - random( 10, 2.0, false, {} ); // $ExpectError - random( 10, 2.0, null, {} ); // $ExpectError - random( 10, 2.0, [], {} ); // $ExpectError - random( 10, 2.0, {}, {} ); // $ExpectError - random( 10, 2.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, '5' ); // $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, [] ); // $ExpectError - random( 10, 2.0, 5.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, { 'dtype': 123 } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': null } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - random( 10, 2.0, 5.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 -} - -// Attached to main export is a `factory` method which returns a function... -{ - random.factory( 2.0, 5.0 ); // $ExpectType UnaryFunction - random.factory( 2.0, 5.0, { 'copy': false } ); // $ExpectType UnaryFunction - - random.factory(); // $ExpectType TernaryFunction - random.factory( { 'copy': false } ); // $ExpectType TernaryFunction -} - -// The `factory` method returns a function which returns an array... -{ - const fcn1 = random.factory( 2.0, 5.0 ); - fcn1( 10 ); // $ExpectType RandomArray - - const fcn2 = random.factory(); - fcn2( 10, 2.0, 5.0 ); // $ExpectType RandomArray -} - -// The compiler throws an error if the `factory` method is provided invalid arguments... -{ - random.factory( '5', 5.0 ); // $ExpectError - random.factory( true, 5.0 ); // $ExpectError - random.factory( false, 5.0 ); // $ExpectError - random.factory( [], 5.0 ); // $ExpectError - random.factory( {}, 5.0 ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0 ); // $ExpectError - - random.factory( '5', 5.0, {} ); // $ExpectError - random.factory( true, 5.0, {} ); // $ExpectError - random.factory( false, 5.0, {} ); // $ExpectError - random.factory( [], 5.0, {} ); // $ExpectError - random.factory( {}, 5.0, {} ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0, {} ); // $ExpectError - - random.factory( 2.0, '5' ); // $ExpectError - random.factory( 2.0, true ); // $ExpectError - random.factory( 2.0, false ); // $ExpectError - random.factory( 2.0, [] ); // $ExpectError - random.factory( 2.0, {} ); // $ExpectError - random.factory( 2.0, ( x: number ): number => x ); // $ExpectError - - random.factory( 2.0, '5', {} ); // $ExpectError - random.factory( 2.0, true, {} ); // $ExpectError - random.factory( 2.0, false, {} ); // $ExpectError - random.factory( 2.0, [], {} ); // $ExpectError - random.factory( 2.0, {}, {} ); // $ExpectError - random.factory( 2.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, 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, { 'prng': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'seed': true } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': [ 'a' ] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'state': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': {} } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': true ); // $ExpectError - random.factory( 2.0, 5.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, { 'copy': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'dtype': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - random.factory( 2.0, 5.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, {}, {} ); // $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 ); - 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 ); // $ExpectError - fcn2( false, 2.0, 5.0 ); // $ExpectError - fcn2( '5', 2.0, 5.0 ); // $ExpectError - fcn2( [], 2.0, 5.0 ); // $ExpectError - fcn2( {}, 2.0, 5.0 ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - fcn2( true, 2.0, 5.0, {} ); // $ExpectError - fcn2( false, 2.0, 5.0, {} ); // $ExpectError - fcn2( '5', 2.0, 5.0, {} ); // $ExpectError - fcn2( [], 2.0, 5.0, {} ); // $ExpectError - fcn2( {}, 2.0, 5.0, {} ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0, {} ); // $ExpectError - - fcn2( 10, true, 5.0 ); // $ExpectError - fcn2( 10, false, 5.0 ); // $ExpectError - fcn2( 10, '5', 5.0 ); // $ExpectError - fcn2( 10, [], 5.0 ); // $ExpectError - fcn2( 10, {}, 5.0 ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0 ); // $ExpectError - - fcn2( 10, true, 5.0, {} ); // $ExpectError - fcn2( 10, false, 5.0, {} ); // $ExpectError - fcn2( 10, '5', 5.0, {} ); // $ExpectError - fcn2( 10, [], 5.0, {} ); // $ExpectError - fcn2( 10, {}, 5.0, {} ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0, {} ); // $ExpectError - - fcn2( 10, 2.0, true ); // $ExpectError - fcn2( 10, 2.0, false ); // $ExpectError - fcn2( 10, 2.0, '5' ); // $ExpectError - fcn2( 10, 2.0, [] ); // $ExpectError - fcn2( 10, 2.0, {} ); // $ExpectError - fcn2( 10, 2.0, ( x: number ): number => x ); // $ExpectError - - fcn2( 10, 2.0, true, {} ); // $ExpectError - fcn2( 10, 2.0, false, {} ); // $ExpectError - fcn2( 10, 2.0, '5', {} ); // $ExpectError - fcn2( 10, 2.0, [], {} ); // $ExpectError - fcn2( 10, 2.0, {}, {} ); // $ExpectError - fcn2( 10, 2.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, { 'dtype': 123 } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': null } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError - - const fcn2 = random.factory( 2.0, 5.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 ); - fcn1(); // $ExpectError - fcn1( 1, 1, 1 ); // $ExpectError - - const fcn2 = random.factory(); - fcn2(); // $ExpectError - fcn2( 1 ); // $ExpectError - fcn2( 1, 1, 1, 1 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index c485546..0000000 --- a/examples/index.js +++ /dev/null @@ -1,48 +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'; - -var logEach = require( '@stdlib/console-log-each' ); -var uniform = require( './../lib' ); - -// Create a function for generating random arrays originating from the same state: -var random = uniform.factory( 2.0, 5.0, { - 'state': uniform.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 = uniform.factory( 2.0, 5.0, { - 'state': uniform.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 d77d803..9b896f6 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 2.0 -/// +/// import { FloatDataType, 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..a4cb981 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-accessor@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-write-accessor@esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-constant-function@esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-noop@v0.0.14-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/random-base-uniform@esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-typed-real-float-ctors@esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-nullary@esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@esm/index.mjs";import f from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.0.2-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/array-typed-real-float-dtypes@esm/index.mjs";import h from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@esm/index.mjs";var u="float64",c=a();function y(e,t){return h(t)?j(t,"dtype")&&(e.dtype=t.dtype,c.indexOf(e.dtype)<0)?new TypeError(f("null3t","dtype",c.join('", "'),e.dtype)):null:new TypeError(f("null2h",t))}function g(){var a,h,j,c,g,b;if(j={dtype:u},0===(h=arguments.length))g=d,c=x;else if(1===h){if(a=arguments[0],g=d.factory(a),b=y(j,a))throw b;c=x}else if(2===h)g=d.factory(arguments[0],arguments[1]),c=v;else if(3===h){if(a=arguments[2],g=d.factory(arguments[0],arguments[1],a),b=y(j,a))throw b;c=v}return a&&a.prng?(e(c,"seed",null),e(c,"seedLength",null),s(c,"state",r(null),i),e(c,"stateLength",null),e(c,"byteLength",null)):(n(c,"seed",w),n(c,"seedLength",L),s(c,"state",P,R),n(c,"stateLength",G),n(c,"byteLength",N)),e(c,"PRNG",g.PRNG),c;function v(e,n){var s,r,i,d;if(!t(e))throw new TypeError(f("null2p",e));if(d={},arguments.length>1&&(r=y(d,n)))throw r;return"generic"===(i=d.dtype||j.dtype)?l(e,g):(s=new(o(i))(e),m([s],[e],[1],g),s)}function x(e,n,s,r){var i,d,m,a;if(!t(e))throw new TypeError(f("null2p",e));if(a={},arguments.length>3&&(d=y(a,r)))throw d;return"generic"===(m=a.dtype||j.dtype)?l(e,h):(i=new(o(m))(e),p([[n],[s],i],[e],[0,0,1],g),i);function h(){return g(n,s)}}function w(){return c.PRNG.seed}function L(){return c.PRNG.seedLength}function G(){return c.PRNG.stateLength}function N(){return c.PRNG.byteLength}function P(){return c.PRNG.state}function R(e){c.PRNG.state=e}}c.push("generic");var b=g();e(b,"factory",g);export{b as default,g as factory}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..4984bd1 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/factory.js","../lib/main.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 dtypes from '@stdlib/array-typed-real-float-dtypes';\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes();\nDTYPES.push( 'generic' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( 'null2h', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( DTYPES.indexOf( opts.dtype ) < 0 ) {\n\t\t\treturn new TypeError( format( 'null3t', 'dtype', DTYPES.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport setReadOnlyAccessor from '@stdlib/utils-define-nonenumerable-read-only-accessor';\nimport setReadWriteAccessor from '@stdlib/utils-define-nonenumerable-read-write-accessor';\nimport constantFunction from '@stdlib/utils-constant-function';\nimport noop from '@stdlib/utils-noop';\nimport base from '@stdlib/random-base-uniform';\nimport ctors from '@stdlib/array-typed-real-float-ctors';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport nullary from '@stdlib/strided-base-nullary';\nimport binary from '@stdlib/strided-base-binary';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution.\n*\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\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 {RangeError} `a` must be less than `b`\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 uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10 );\n* // returns \n*\n* @example\n* var uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nfunction factory() {\n\tvar options;\n\tvar nargs;\n\tvar opts;\n\tvar rand;\n\tvar prng;\n\tvar err;\n\n\topts = {\n\t\t'dtype': defaults.dtype\n\t};\n\n\tnargs = arguments.length;\n\tif ( nargs === 0 ) {\n\t\tprng = base;\n\t\trand = uniform2;\n\t} else if ( nargs === 1 ) {\n\t\toptions = arguments[ 0 ];\n\t\tprng = base.factory( options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform2;\n\t} else if ( nargs === 2 ) {\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ] );\n\t\trand = uniform1;\n\t} else if ( nargs === 3 ) {\n\t\toptions = arguments[ 2 ];\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ], options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform1;\n\t}\n\tif ( options && options.prng ) {\n\t\tsetReadOnly( rand, 'seed', null );\n\t\tsetReadOnly( rand, 'seedLength', null );\n\t\tsetReadWriteAccessor( rand, 'state', constantFunction( null ), noop );\n\t\tsetReadOnly( rand, 'stateLength', null );\n\t\tsetReadOnly( rand, 'byteLength', null );\n\t} else {\n\t\tsetReadOnlyAccessor( rand, 'seed', getSeed );\n\t\tsetReadOnlyAccessor( rand, 'seedLength', getSeedLength );\n\t\tsetReadWriteAccessor( rand, 'state', getState, setState );\n\t\tsetReadOnlyAccessor( rand, 'stateLength', getStateLength );\n\t\tsetReadOnlyAccessor( rand, 'byteLength', getStateSize );\n\t}\n\tsetReadOnly( rand, 'PRNG', prng.PRNG );\n\treturn rand;\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform1( len, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( 'null2p', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 1 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, prng );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tnullary( [ out ], [ len ], [ 1 ], prng );\n\t\treturn out;\n\t}\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {number} a - minimum support\n\t* @param {number} b - maximum support\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform2( len, a, b, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( 'null2p', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 3 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\t// NOTE: we could alternatively use the PRNG factory function to create a PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. Decision made here to avoid this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom number. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in a return value of `NaN`.\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, wrapper );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tbinary( [ [ a ], [ b ], out ], [ len ], [ 0, 0, 1 ], prng );\n\t\treturn out;\n\n\t\t/**\n\t\t* Applies parameters to a pseudorandom number generator function.\n\t\t*\n\t\t* @private\n\t\t* @returns {number} pseudorandom number\n\t\t*/\n\t\tfunction wrapper() {\n\t\t\treturn prng( a, b );\n\t\t}\n\t}\n\n\t/**\n\t* Returns the PRNG seed.\n\t*\n\t* @private\n\t* @returns {PRNGSeedMT19937} seed\n\t*/\n\tfunction getSeed() {\n\t\treturn rand.PRNG.seed;\n\t}\n\n\t/**\n\t* Returns the PRNG seed length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} seed length\n\t*/\n\tfunction getSeedLength() {\n\t\treturn rand.PRNG.seedLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state length\n\t*/\n\tfunction getStateLength() {\n\t\treturn rand.PRNG.stateLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state size (in bytes).\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state size (in bytes)\n\t*/\n\tfunction getStateSize() {\n\t\treturn rand.PRNG.byteLength;\n\t}\n\n\t/**\n\t* Returns the current pseudorandom number generator state.\n\t*\n\t* @private\n\t* @returns {PRNGStateMT19937} current state\n\t*/\n\tfunction getState() {\n\t\treturn rand.PRNG.state;\n\t}\n\n\t/**\n\t* Sets the pseudorandom number generator state.\n\t*\n\t* @private\n\t* @param {PRNGStateMT19937} s - generator state\n\t* @throws {Error} must provide a valid state\n\t*/\n\tfunction setState( s ) {\n\t\trand.PRNG.state = s;\n\t}\n}\n\n\n// EXPORTS //\n\nexport default factory;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @name uniform\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\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 = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar uniform = factory();\n\n\n// EXPORTS //\n\nexport default uniform;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @module @stdlib/random-array-uniform\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.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\" }\n"],"names":["DTYPES","dtypes","validate","opts","options","isObject","hasOwnProp","dtype","indexOf","TypeError","format","join","factory","nargs","rand","prng","err","defaults","arguments","length","base","uniform2","uniform1","setReadOnly","setReadWriteAccessor","constantFunction","noop","setReadOnlyAccessor","getSeed","getSeedLength","getState","setState","getStateLength","getStateSize","PRNG","len","out","dt","o","isNonNegativeInteger","filledBy","ctors","nullary","a","b","wrapper","binary","seed","seedLength","stateLength","byteLength","state","s","push","uniform","main"],"mappings":";;07CA8BIA,EAASC,IAyBb,SAASC,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,WACzBD,EAAKI,MAAQH,EAAQG,MAChBP,EAAOQ,QAASL,EAAKI,OAAU,GAC5B,IAAIE,UAAWC,EAAQ,SAAU,QAASV,EAAOW,KAAM,QAAUR,EAAKI,QAGxE,KARC,IAAIE,UAAWC,EAAQ,SAAUN,GAS1C,CCSA,SAASQ,IACR,IAAIR,EACAS,EACAV,EACAW,EACAC,EACAC,EAOJ,GALAb,EAAO,CACNI,MAASU,GAIK,KADfJ,EAAQK,UAAUC,QAEjBJ,EAAOK,EACPN,EAAOO,OACD,GAAe,IAAVR,EAAc,CAIzB,GAHAT,EAAUc,UAAW,GACrBH,EAAOK,EAAKR,QAASR,GACrBY,EAAMd,EAAUC,EAAMC,GAErB,MAAMY,EAEPF,EAAOO,CACT,MAAQ,GAAe,IAAVR,EACXE,EAAOK,EAAKR,QAASM,UAAW,GAAKA,UAAW,IAChDJ,EAAOQ,OACD,GAAe,IAAVT,EAAc,CAIzB,GAHAT,EAAUc,UAAW,GACrBH,EAAOK,EAAKR,QAASM,UAAW,GAAKA,UAAW,GAAKd,GACrDY,EAAMd,EAAUC,EAAMC,GAErB,MAAMY,EAEPF,EAAOQ,CACP,CAeD,OAdKlB,GAAWA,EAAQW,MACvBQ,EAAaT,EAAM,OAAQ,MAC3BS,EAAaT,EAAM,aAAc,MACjCU,EAAsBV,EAAM,QAASW,EAAkB,MAAQC,GAC/DH,EAAaT,EAAM,cAAe,MAClCS,EAAaT,EAAM,aAAc,QAEjCa,EAAqBb,EAAM,OAAQc,GACnCD,EAAqBb,EAAM,aAAce,GACzCL,EAAsBV,EAAM,QAASgB,EAAUC,GAC/CJ,EAAqBb,EAAM,cAAekB,GAC1CL,EAAqBb,EAAM,aAAcmB,IAE1CV,EAAaT,EAAM,OAAQC,EAAKmB,MACzBpB,EAcP,SAASQ,EAAUa,EAAK/B,GACvB,IACIgC,EACApB,EACAqB,EACAC,EACJ,IAAMC,EAAsBJ,GAC3B,MAAM,IAAI1B,UAAWC,EAAQ,SAAUyB,IAGxC,GADAG,EAAI,CAAA,EACCpB,UAAUC,OAAS,IACvBH,EAAMd,EAAUoC,EAAGlC,IAElB,MAAMY,EAIR,MAAY,aADZqB,EAAKC,EAAE/B,OAASJ,EAAKI,OAEbiC,EAAUL,EAAKpB,IAGvBqB,EAAM,IADCK,EAAOJ,GACR,CAAUF,GAChBO,EAAS,CAAEN,GAAO,CAAED,GAAO,CAAE,GAAKpB,GAC3BqB,EACP,CAgBD,SAASf,EAAUc,EAAKQ,EAAGC,EAAGxC,GAC7B,IACIgC,EACApB,EACAqB,EACAC,EACJ,IAAMC,EAAsBJ,GAC3B,MAAM,IAAI1B,UAAWC,EAAQ,SAAUyB,IAGxC,GADAG,EAAI,CAAA,EACCpB,UAAUC,OAAS,IACvBH,EAAMd,EAAUoC,EAAGlC,IAElB,MAAMY,EAKR,MAAY,aADZqB,EAAKC,EAAE/B,OAASJ,EAAKI,OAEbiC,EAAUL,EAAKU,IAGvBT,EAAM,IADCK,EAAOJ,GACR,CAAUF,GAChBW,EAAQ,CAAE,CAAEH,GAAK,CAAEC,GAAKR,GAAO,CAAED,GAAO,CAAE,EAAG,EAAG,GAAKpB,GAC9CqB,GAQP,SAASS,IACR,OAAO9B,EAAM4B,EAAGC,EAChB,CACD,CAQD,SAAShB,IACR,OAAOd,EAAKoB,KAAKa,IACjB,CAQD,SAASlB,IACR,OAAOf,EAAKoB,KAAKc,UACjB,CAQD,SAAShB,IACR,OAAOlB,EAAKoB,KAAKe,WACjB,CAQD,SAAShB,IACR,OAAOnB,EAAKoB,KAAKgB,UACjB,CAQD,SAASpB,IACR,OAAOhB,EAAKoB,KAAKiB,KACjB,CASD,SAASpB,EAAUqB,GAClBtC,EAAKoB,KAAKiB,MAAQC,CAClB,CACF,CDrPApD,EAAOqD,KAAM,WEqBV,IAACC,EAAU1C,ICiBdW,EAAAgC,EAAA,UAAA3C"} \ No newline at end of file diff --git a/lib/defaults.json b/lib/defaults.json deleted file mode 100644 index 83f4438..0000000 --- a/lib/defaults.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "dtype": "float64" -} diff --git a/lib/factory.js b/lib/factory.js deleted file mode 100644 index 9f232af..0000000 --- a/lib/factory.js +++ /dev/null @@ -1,282 +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 isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var setReadOnlyAccessor = require( '@stdlib/utils-define-nonenumerable-read-only-accessor' ); -var setReadWriteAccessor = require( '@stdlib/utils-define-nonenumerable-read-write-accessor' ); -var constantFunction = require( '@stdlib/utils-constant-function' ); -var noop = require( '@stdlib/utils-noop' ); -var base = require( '@stdlib/random-base-uniform' ); -var ctors = require( '@stdlib/array-typed-real-float-ctors' ); -var filledBy = require( '@stdlib/array-base-filled-by' ); -var nullary = require( '@stdlib/strided-base-nullary' ); -var binary = require( '@stdlib/strided-base-binary' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution. -* -* @param {number} [a] - minimum support -* @param {number} [b] - maximum support -* @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 {RangeError} `a` must be less than `b` -* @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 uniform = factory( 2.0, 5.0 ); -* // returns -* -* var arr = uniform( 10 ); -* // returns -* -* @example -* var uniform = factory( 2.0, 5.0 ); -* // returns -* -* var arr = uniform( 10, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -function factory() { - var options; - var nargs; - var opts; - var rand; - var prng; - var err; - - opts = { - 'dtype': defaults.dtype - }; - - nargs = arguments.length; - if ( nargs === 0 ) { - prng = base; - rand = uniform2; - } else if ( nargs === 1 ) { - options = arguments[ 0 ]; - prng = base.factory( options ); - err = validate( opts, options ); - if ( err ) { - throw err; - } - rand = uniform2; - } else if ( nargs === 2 ) { - prng = base.factory( arguments[ 0 ], arguments[ 1 ] ); - rand = uniform1; - } else if ( nargs === 3 ) { - options = arguments[ 2 ]; - prng = base.factory( arguments[ 0 ], arguments[ 1 ], options ); - err = validate( opts, options ); - if ( err ) { - throw err; - } - rand = uniform1; - } - if ( options && options.prng ) { - setReadOnly( rand, 'seed', null ); - setReadOnly( rand, 'seedLength', null ); - setReadWriteAccessor( rand, 'state', constantFunction( null ), noop ); - setReadOnly( rand, 'stateLength', null ); - setReadOnly( rand, 'byteLength', null ); - } else { - setReadOnlyAccessor( rand, 'seed', getSeed ); - setReadOnlyAccessor( rand, 'seedLength', getSeedLength ); - setReadWriteAccessor( rand, 'state', getState, setState ); - setReadOnlyAccessor( rand, 'stateLength', getStateLength ); - setReadOnlyAccessor( rand, 'byteLength', getStateSize ); - } - setReadOnly( rand, 'PRNG', prng.PRNG ); - return rand; - - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @private - * @param {NonNegativeInteger} len - array length - * @param {Options} [options] - function options - * @param {string} [options.dtype] - 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 - */ - function uniform1( len, options ) { - var ctor; - var out; - var err; - var dt; - var o; - if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( 'null2p', len ) ); - } - o = {}; - if ( arguments.length > 1 ) { - err = validate( o, options ); - if ( err ) { - throw err; - } - } - dt = o.dtype || opts.dtype; - if ( dt === 'generic' ) { - return filledBy( len, prng ); - } - ctor = ctors( dt ); - out = new ctor( len ); - nullary( [ out ], [ len ], [ 1 ], prng ); - return out; - } - - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @private - * @param {NonNegativeInteger} len - array length - * @param {number} a - minimum support - * @param {number} b - maximum support - * @param {Options} [options] - function options - * @param {string} [options.dtype] - 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 - */ - function uniform2( len, a, b, options ) { - var ctor; - var out; - var err; - var dt; - var o; - if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( 'null2p', len ) ); - } - o = {}; - if ( arguments.length > 3 ) { - err = validate( o, options ); - if ( err ) { - throw err; - } - } - // NOTE: we could alternatively use the PRNG factory function to create a PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. Decision made here to avoid this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom number. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in a return value of `NaN`. - dt = o.dtype || opts.dtype; - if ( dt === 'generic' ) { - return filledBy( len, wrapper ); - } - ctor = ctors( dt ); - out = new ctor( len ); - binary( [ [ a ], [ b ], out ], [ len ], [ 0, 0, 1 ], prng ); - return out; - - /** - * Applies parameters to a pseudorandom number generator function. - * - * @private - * @returns {number} pseudorandom number - */ - function wrapper() { - return prng( a, b ); - } - } - - /** - * Returns the PRNG seed. - * - * @private - * @returns {PRNGSeedMT19937} seed - */ - function getSeed() { - return rand.PRNG.seed; - } - - /** - * Returns the PRNG seed length. - * - * @private - * @returns {PositiveInteger} seed length - */ - function getSeedLength() { - return rand.PRNG.seedLength; - } - - /** - * Returns the PRNG state length. - * - * @private - * @returns {PositiveInteger} state length - */ - function getStateLength() { - return rand.PRNG.stateLength; - } - - /** - * Returns the PRNG state size (in bytes). - * - * @private - * @returns {PositiveInteger} state size (in bytes) - */ - function getStateSize() { - return rand.PRNG.byteLength; - } - - /** - * Returns the current pseudorandom number generator state. - * - * @private - * @returns {PRNGStateMT19937} current state - */ - function getState() { - return rand.PRNG.state; - } - - /** - * Sets the pseudorandom number generator state. - * - * @private - * @param {PRNGStateMT19937} s - generator state - * @throws {Error} must provide a valid state - */ - function setState( s ) { - rand.PRNG.state = s; - } -} - - -// EXPORTS // - -module.exports = factory; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 0077f00..0000000 --- a/lib/index.js +++ /dev/null @@ -1,77 +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'; - -/** -* Create an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. -* -* @module @stdlib/random-array-uniform -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var arr = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var arr = uniform( 10, 2.0, 5.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var rand = uniform.factory( 2.0, 5.0 ); -* // returns -* -* var arr = rand( 10 ); -* // returns -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var rand = uniform.factory( 2.0, 5.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" } diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index da0d9b1..0000000 --- a/lib/main.js +++ /dev/null @@ -1,58 +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 factory = require( './factory.js' ); - - -// MAIN // - -/** -* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. -* -* @name uniform -* @type {Function} -* @param {NonNegativeInteger} len - array length -* @param {number} a - minimum support -* @param {number} b - maximum support -* @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 = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var arr = uniform( 10, 2.0, 5.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -var uniform = factory(); - - -// EXPORTS // - -module.exports = uniform; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index 3629aaf..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,72 +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 dtypes = require( '@stdlib/array-typed-real-float-dtypes' ); -var isObject = require( '@stdlib/assert-is-plain-object' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// VARIABLES // - -var DTYPES = dtypes(); -DTYPES.push( 'generic' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Options} options - function options -* @param {string} [options.dtype] - output array data type -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var options = { -* 'dtype': 'float64' -* }; -* var err = validate( opts, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( 'null2h', options ) ); - } - if ( hasOwnProp( options, 'dtype' ) ) { - opts.dtype = options.dtype; - if ( DTYPES.indexOf( opts.dtype ) < 0 ) { - return new TypeError( format( 'null3t', 'dtype', DTYPES.join( '", "' ), opts.dtype ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index 8b6d28d..621da6a 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 continuous uniform 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,55 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-filled-by": "^0.0.2", - "@stdlib/array-typed-real-float-ctors": "^0.0.1", - "@stdlib/array-typed-real-float-dtypes": "^0.0.1", - "@stdlib/assert-has-own-property": "^0.0.7", - "@stdlib/assert-is-nonnegative-integer": "^0.0.7", - "@stdlib/assert-is-plain-object": "^0.0.7", - "@stdlib/random-base-uniform": "^0.0.6", - "@stdlib/strided-base-binary": "^0.0.8", - "@stdlib/strided-base-nullary": "^0.0.7", - "@stdlib/error-tools-fmtprodmsg": "^0.0.2", - "@stdlib/types": "^0.0.14", - "@stdlib/utils-constant-function": "^0.0.8", - "@stdlib/utils-define-nonenumerable-read-only-accessor": "^0.0.7", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.7", - "@stdlib/utils-define-nonenumerable-read-write-accessor": "^0.0.7", - "@stdlib/utils-noop": "^0.0.14" - }, - "devDependencies": { - "@stdlib/array-float32": "^0.0.6", - "@stdlib/array-float64": "^0.0.6", - "@stdlib/array-uint32": "^0.0.6", - "@stdlib/assert-is-uint32array": "^0.0.8", - "@stdlib/bench": "^0.0.12", - "@stdlib/console-log-each": "^0.0.2", - "@stdlib/constants-uint32-max": "^0.0.7", - "@stdlib/math-base-assert-is-nan": "^0.0.8", - "@stdlib/math-base-assert-is-nanf": "^0.0.8", - "@stdlib/math-base-special-pow": "^0.0.7", - "@stdlib/random-base-minstd": "^0.0.6", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdmath", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..abbea01 --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/test.factory.js b/test/test.factory.js deleted file mode 100644 index a869e75..0000000 --- a/test/test.factory.js +++ /dev/null @@ -1,1328 +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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -tape( 'the function throws an error if the second distribution parameter is less than the first distribution parameter', function test( t ) { - var values; - var i; - - values = [ - [ 0.0, 0.0 ], - [ -2.0, -4.0 ], - [ 2.0, 1.0 ] - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( arr ) { - return function badValue() { - factory( arr[0], arr[1] ); - }; - } -}); - -tape( 'the function throws an error if the second distribution parameter is less than the first distribution parameter (options)', function test( t ) { - var values; - var i; - - values = [ - [ 0.0, 0.0 ], - [ -2.0, -4.0 ], - [ 2.0, 1.0 ] - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( arr ) { - return function badValue() { - factory( arr[0], arr[1], {} ); - }; - } -}); - -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, 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, { - '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, { - '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, { - '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, { - '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, { - '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, { - '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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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 ); - - 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 ); - - 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, { - '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 ); - - 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 ); - 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( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory(); - actual = random( 10, 2.0, 5.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( typeof actual[ i ], 'number', '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 ); - - 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 ); - - 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 ); - - 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 that generates `NaN` values if the first distribution parameter is greater than or equal to the second distribution parameter', function test( t ) { - var random; - var values; - var actual; - var i; - var j; - - random = factory(); - values = [ - [ 2.0, 1.0 ], - [ -3.0, -4.0 ], - [ 0.0, 0.0 ] - ]; - - for ( i = 0; i < values.length; i++ ) { - actual = random( 10, values[ i ][ 0 ], values[ i ][ 1 ] ); - for ( j = 0; j < actual.length; j++ ) { - t.strictEqual( isnan( actual[ j ] ), true, 'returns expected value when provided '+values[ 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, { - '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 ); - - 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, { - '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( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'float64' - }); - actual = random( 10, 2.0, 5.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( typeof actual[ i ], 'number', '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, { - '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( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'float32' - }); - actual = random( 10, 2.0, 5.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( typeof actual[ i ], 'number', '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, { - '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 ); - - 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, { - '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, { - '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 ); - - // 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, { - '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 ); - - // 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, { - '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 ); - - 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, { - 'prng': randu.normalized - }); - - randu = minstd.factory({ - 'seed': seed - }); - random2 = factory( 2.0, 5.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 ); - arr2 = random2( 10, 2.0, 5.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 c4fb6d3..0000000 --- a/test/test.js +++ /dev/null @@ -1,69 +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 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 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 37b0080..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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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, 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, { - '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 ); - - 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( typeof actual[ i ], 'number', '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, { - '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( typeof actual[ i ], 'number', '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, { - '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( typeof actual[ i ], 'number', '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, { - '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 ); - } - // Capture the current state: - state = random.state; - - // Move to a future state... - arr = random( 10, 2.0, 5.0 ); - for ( i = 0; i < 100; i++ ) { - random( 2, 2.0, 5.0 ); - } - // Set the state: - random.state = state; - - // Replay previously generated values: - t.deepEqual( random( 10, 2.0, 5.0 ), arr, 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.validate.js b/test/test.validate.js deleted file mode 100644 index c515526..0000000 --- a/test/test.validate.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 validate = require( './../lib/validate.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.equal( typeof validate, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function returns an error if provided an options argument which is not an object', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - void 0, - null, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, values[ i ] ); - t.equal( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided a `dtype` option which is not a supported data type', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - -5, - NaN, - true, - false, - void 0, - null, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, { - 'dtype': values[ i ] - }); - t.equal( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns null if all options are valid', function test( t ) { - var options; - var opts; - var err; - - options = { - 'dtype': 'float64' - }; - opts = {}; - err = validate( opts, options ); - - t.equal( err, null, 'returns null' ); - t.deepEqual( opts, options, 'sets option values' ); - - t.end(); -}); - -tape( 'the function ignores unrecognized/unsupported options', function test( t ) { - var options; - var opts; - var err; - - options = { - 'beep': true, - 'boop': 'bop' - }; - opts = {}; - err = validate( opts, options ); - - t.equal( err, null, 'returns null' ); - t.deepEqual( opts, {}, 'does not set any option values' ); - t.end(); -}); From 6997605785d29c44fcbb561160c64ffa3ff64114 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 31 Jul 2023 15:07:54 +0000 Subject: [PATCH 21/82] Transform error messages --- lib/factory.js | 6 +++--- lib/validate.js | 6 +++--- package.json | 2 +- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/lib/factory.js b/lib/factory.js index 22ec236..9f232af 100644 --- a/lib/factory.js +++ b/lib/factory.js @@ -31,7 +31,7 @@ var ctors = require( '@stdlib/array-typed-real-float-ctors' ); var filledBy = require( '@stdlib/array-base-filled-by' ); var nullary = require( '@stdlib/strided-base-nullary' ); var binary = require( '@stdlib/strided-base-binary' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -144,7 +144,7 @@ function factory() { var dt; var o; if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) ); + throw new TypeError( format( 'null2p', len ) ); } o = {}; if ( arguments.length > 1 ) { @@ -184,7 +184,7 @@ function factory() { var dt; var o; if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) ); + throw new TypeError( format( 'null2p', len ) ); } o = {}; if ( arguments.length > 3 ) { diff --git a/lib/validate.js b/lib/validate.js index 40b9723..3629aaf 100644 --- a/lib/validate.js +++ b/lib/validate.js @@ -23,7 +23,7 @@ var dtypes = require( '@stdlib/array-typed-real-float-dtypes' ); var isObject = require( '@stdlib/assert-is-plain-object' ); var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // VARIABLES // @@ -55,12 +55,12 @@ DTYPES.push( 'generic' ); */ function validate( opts, options ) { if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); + return new TypeError( format( 'null2h', options ) ); } if ( hasOwnProp( options, 'dtype' ) ) { opts.dtype = options.dtype; if ( DTYPES.indexOf( opts.dtype ) < 0 ) { - return new TypeError( format( 'invalid option. `%s` option must be one of the following: "%s". Option: `%s`.', 'dtype', DTYPES.join( '", "' ), opts.dtype ) ); + return new TypeError( format( 'null3t', 'dtype', DTYPES.join( '", "' ), opts.dtype ) ); } } return null; diff --git a/package.json b/package.json index 656387a..0950c02 100644 --- a/package.json +++ b/package.json @@ -46,7 +46,7 @@ "@stdlib/random-base-uniform": "^0.0.6", "@stdlib/strided-base-binary": "^0.0.8", "@stdlib/strided-base-nullary": "^0.0.7", - "@stdlib/string-format": "^0.0.3", + "@stdlib/error-tools-fmtprodmsg": "^0.0.2", "@stdlib/types": "^0.0.14", "@stdlib/utils-constant-function": "^0.0.8", "@stdlib/utils-define-nonenumerable-read-only-accessor": "^0.0.7", From 66ef4e5f0b54c60377ae685d185807ba8229c0b3 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 31 Jul 2023 15:09:22 +0000 Subject: [PATCH 22/82] Remove files --- index.d.ts | 245 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6427 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 9b896f6..0000000 --- a/index.d.ts +++ /dev/null @@ -1,245 +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. -*/ - -// TypeScript Version: 2.0 - -/// - -import { FloatDataType, FloatTypedArray } from '@stdlib/types/array'; -import * as random from '@stdlib/types/random'; - -/** -* Supported data types. -*/ -type DataType = FloatDataType | 'generic'; - -/** -* 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 continuous uniform distribution with pre-specified parameter values. -*/ -interface UnaryFunction extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @param len - array length - * @param options - function options - * @returns output array - */ - ( len: number, options?: Options ): RandomArray; -} - -/** -* Interface for generating pseudorandom numbers drawn from a continuous uniform distribution without pre-specified parameter values. -*/ -interface TernaryFunction extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @param len - array length - * @param a - minimum support - * @param b - maximum support - * @param options - function options - * @returns output array - */ - ( len: number, a: number, b: number, options?: Options ): RandomArray; -} - -/** -* Interface for generating pseudorandom numbers drawn from a uniform distribution. -*/ -interface Random extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @param len - array length - * @param a - minimum support - * @param b - maximum support - * @param options - function options - * @returns output array - * - * @example - * var out = uniform( 10, 2.0, 5.0 ); - * // returns - */ - ( len: number, a: number, b: number, options?: Options ): RandomArray; - - /** - * Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution. - * - * ## Notes - * - * - When provided `a` and `b`, the returned function returns random variates drawn from the specified distribution. - * - * @param a - minimum support - * @param b - maximum support - * @param options - function options - * @throws `a` must be less than `b` - * @throws must provide a valid state - * @returns function for creating arrays - * - * @example - * var random = uniform.factory( 2.0, 5.0 ); - * - * var out = random( 10 ); - * // returns - * - * @example - * var random = uniform.factory( 2.0, 5.0, { - * 'seed': 297 - * }); - * var out = random( 10 ); - * // returns - */ - factory( a: number, b: number, options?: FactoryOptions ): UnaryFunction; - - /** - * Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution. - * - * ## Notes - * - * - When not provided `a` and `b`, the returned function requires that both `a` and `b` be provided at each invocation. - * - * @param options - function options - * @throws must provide a valid state - * @returns function for creating arrays - * - * @example - * var random = uniform.factory(); - * - * var out = random( 10, 2.0, 5.0 ); - * // returns - * - * @example - * var random = uniform.factory({ - * 'seed': 297 - * }); - * var out = random( 10, 2.0, 5.0 ); - * // returns - */ - factory( options?: FactoryOptions ): TernaryFunction; -} - -/** -* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. -* -* @param len - array length -* @param a - minimum support -* @param b - maximum support -* @param options - function options -* @returns output array -* -* @example -* var out = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var random = uniform.factory( 2.0, 5.0 ); -* -* var out = random( 10 ); -* // returns -*/ -declare var uniform: Random; - - -// EXPORTS // - -export = uniform; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index a4cb981..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-accessor@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-write-accessor@esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-constant-function@esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-noop@v0.0.14-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/random-base-uniform@esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-typed-real-float-ctors@esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-nullary@esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@esm/index.mjs";import f from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.0.2-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/array-typed-real-float-dtypes@esm/index.mjs";import h from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@esm/index.mjs";var u="float64",c=a();function y(e,t){return h(t)?j(t,"dtype")&&(e.dtype=t.dtype,c.indexOf(e.dtype)<0)?new TypeError(f("null3t","dtype",c.join('", "'),e.dtype)):null:new TypeError(f("null2h",t))}function g(){var a,h,j,c,g,b;if(j={dtype:u},0===(h=arguments.length))g=d,c=x;else if(1===h){if(a=arguments[0],g=d.factory(a),b=y(j,a))throw b;c=x}else if(2===h)g=d.factory(arguments[0],arguments[1]),c=v;else if(3===h){if(a=arguments[2],g=d.factory(arguments[0],arguments[1],a),b=y(j,a))throw b;c=v}return a&&a.prng?(e(c,"seed",null),e(c,"seedLength",null),s(c,"state",r(null),i),e(c,"stateLength",null),e(c,"byteLength",null)):(n(c,"seed",w),n(c,"seedLength",L),s(c,"state",P,R),n(c,"stateLength",G),n(c,"byteLength",N)),e(c,"PRNG",g.PRNG),c;function v(e,n){var s,r,i,d;if(!t(e))throw new TypeError(f("null2p",e));if(d={},arguments.length>1&&(r=y(d,n)))throw r;return"generic"===(i=d.dtype||j.dtype)?l(e,g):(s=new(o(i))(e),m([s],[e],[1],g),s)}function x(e,n,s,r){var i,d,m,a;if(!t(e))throw new TypeError(f("null2p",e));if(a={},arguments.length>3&&(d=y(a,r)))throw d;return"generic"===(m=a.dtype||j.dtype)?l(e,h):(i=new(o(m))(e),p([[n],[s],i],[e],[0,0,1],g),i);function h(){return g(n,s)}}function w(){return c.PRNG.seed}function L(){return c.PRNG.seedLength}function G(){return c.PRNG.stateLength}function N(){return c.PRNG.byteLength}function P(){return c.PRNG.state}function R(e){c.PRNG.state=e}}c.push("generic");var b=g();e(b,"factory",g);export{b as default,g as factory}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 4984bd1..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/factory.js","../lib/main.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 dtypes from '@stdlib/array-typed-real-float-dtypes';\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes();\nDTYPES.push( 'generic' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( 'null2h', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( DTYPES.indexOf( opts.dtype ) < 0 ) {\n\t\t\treturn new TypeError( format( 'null3t', 'dtype', DTYPES.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport setReadOnlyAccessor from '@stdlib/utils-define-nonenumerable-read-only-accessor';\nimport setReadWriteAccessor from '@stdlib/utils-define-nonenumerable-read-write-accessor';\nimport constantFunction from '@stdlib/utils-constant-function';\nimport noop from '@stdlib/utils-noop';\nimport base from '@stdlib/random-base-uniform';\nimport ctors from '@stdlib/array-typed-real-float-ctors';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport nullary from '@stdlib/strided-base-nullary';\nimport binary from '@stdlib/strided-base-binary';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution.\n*\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\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 {RangeError} `a` must be less than `b`\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 uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10 );\n* // returns \n*\n* @example\n* var uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nfunction factory() {\n\tvar options;\n\tvar nargs;\n\tvar opts;\n\tvar rand;\n\tvar prng;\n\tvar err;\n\n\topts = {\n\t\t'dtype': defaults.dtype\n\t};\n\n\tnargs = arguments.length;\n\tif ( nargs === 0 ) {\n\t\tprng = base;\n\t\trand = uniform2;\n\t} else if ( nargs === 1 ) {\n\t\toptions = arguments[ 0 ];\n\t\tprng = base.factory( options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform2;\n\t} else if ( nargs === 2 ) {\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ] );\n\t\trand = uniform1;\n\t} else if ( nargs === 3 ) {\n\t\toptions = arguments[ 2 ];\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ], options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform1;\n\t}\n\tif ( options && options.prng ) {\n\t\tsetReadOnly( rand, 'seed', null );\n\t\tsetReadOnly( rand, 'seedLength', null );\n\t\tsetReadWriteAccessor( rand, 'state', constantFunction( null ), noop );\n\t\tsetReadOnly( rand, 'stateLength', null );\n\t\tsetReadOnly( rand, 'byteLength', null );\n\t} else {\n\t\tsetReadOnlyAccessor( rand, 'seed', getSeed );\n\t\tsetReadOnlyAccessor( rand, 'seedLength', getSeedLength );\n\t\tsetReadWriteAccessor( rand, 'state', getState, setState );\n\t\tsetReadOnlyAccessor( rand, 'stateLength', getStateLength );\n\t\tsetReadOnlyAccessor( rand, 'byteLength', getStateSize );\n\t}\n\tsetReadOnly( rand, 'PRNG', prng.PRNG );\n\treturn rand;\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform1( len, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( 'null2p', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 1 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, prng );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tnullary( [ out ], [ len ], [ 1 ], prng );\n\t\treturn out;\n\t}\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {number} a - minimum support\n\t* @param {number} b - maximum support\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform2( len, a, b, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( 'null2p', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 3 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\t// NOTE: we could alternatively use the PRNG factory function to create a PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. Decision made here to avoid this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom number. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in a return value of `NaN`.\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, wrapper );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tbinary( [ [ a ], [ b ], out ], [ len ], [ 0, 0, 1 ], prng );\n\t\treturn out;\n\n\t\t/**\n\t\t* Applies parameters to a pseudorandom number generator function.\n\t\t*\n\t\t* @private\n\t\t* @returns {number} pseudorandom number\n\t\t*/\n\t\tfunction wrapper() {\n\t\t\treturn prng( a, b );\n\t\t}\n\t}\n\n\t/**\n\t* Returns the PRNG seed.\n\t*\n\t* @private\n\t* @returns {PRNGSeedMT19937} seed\n\t*/\n\tfunction getSeed() {\n\t\treturn rand.PRNG.seed;\n\t}\n\n\t/**\n\t* Returns the PRNG seed length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} seed length\n\t*/\n\tfunction getSeedLength() {\n\t\treturn rand.PRNG.seedLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state length\n\t*/\n\tfunction getStateLength() {\n\t\treturn rand.PRNG.stateLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state size (in bytes).\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state size (in bytes)\n\t*/\n\tfunction getStateSize() {\n\t\treturn rand.PRNG.byteLength;\n\t}\n\n\t/**\n\t* Returns the current pseudorandom number generator state.\n\t*\n\t* @private\n\t* @returns {PRNGStateMT19937} current state\n\t*/\n\tfunction getState() {\n\t\treturn rand.PRNG.state;\n\t}\n\n\t/**\n\t* Sets the pseudorandom number generator state.\n\t*\n\t* @private\n\t* @param {PRNGStateMT19937} s - generator state\n\t* @throws {Error} must provide a valid state\n\t*/\n\tfunction setState( s ) {\n\t\trand.PRNG.state = s;\n\t}\n}\n\n\n// EXPORTS //\n\nexport default factory;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @name uniform\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\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 = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar uniform = factory();\n\n\n// EXPORTS //\n\nexport default uniform;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @module @stdlib/random-array-uniform\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.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\" }\n"],"names":["DTYPES","dtypes","validate","opts","options","isObject","hasOwnProp","dtype","indexOf","TypeError","format","join","factory","nargs","rand","prng","err","defaults","arguments","length","base","uniform2","uniform1","setReadOnly","setReadWriteAccessor","constantFunction","noop","setReadOnlyAccessor","getSeed","getSeedLength","getState","setState","getStateLength","getStateSize","PRNG","len","out","dt","o","isNonNegativeInteger","filledBy","ctors","nullary","a","b","wrapper","binary","seed","seedLength","stateLength","byteLength","state","s","push","uniform","main"],"mappings":";;07CA8BIA,EAASC,IAyBb,SAASC,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,WACzBD,EAAKI,MAAQH,EAAQG,MAChBP,EAAOQ,QAASL,EAAKI,OAAU,GAC5B,IAAIE,UAAWC,EAAQ,SAAU,QAASV,EAAOW,KAAM,QAAUR,EAAKI,QAGxE,KARC,IAAIE,UAAWC,EAAQ,SAAUN,GAS1C,CCSA,SAASQ,IACR,IAAIR,EACAS,EACAV,EACAW,EACAC,EACAC,EAOJ,GALAb,EAAO,CACNI,MAASU,GAIK,KADfJ,EAAQK,UAAUC,QAEjBJ,EAAOK,EACPN,EAAOO,OACD,GAAe,IAAVR,EAAc,CAIzB,GAHAT,EAAUc,UAAW,GACrBH,EAAOK,EAAKR,QAASR,GACrBY,EAAMd,EAAUC,EAAMC,GAErB,MAAMY,EAEPF,EAAOO,CACT,MAAQ,GAAe,IAAVR,EACXE,EAAOK,EAAKR,QAASM,UAAW,GAAKA,UAAW,IAChDJ,EAAOQ,OACD,GAAe,IAAVT,EAAc,CAIzB,GAHAT,EAAUc,UAAW,GACrBH,EAAOK,EAAKR,QAASM,UAAW,GAAKA,UAAW,GAAKd,GACrDY,EAAMd,EAAUC,EAAMC,GAErB,MAAMY,EAEPF,EAAOQ,CACP,CAeD,OAdKlB,GAAWA,EAAQW,MACvBQ,EAAaT,EAAM,OAAQ,MAC3BS,EAAaT,EAAM,aAAc,MACjCU,EAAsBV,EAAM,QAASW,EAAkB,MAAQC,GAC/DH,EAAaT,EAAM,cAAe,MAClCS,EAAaT,EAAM,aAAc,QAEjCa,EAAqBb,EAAM,OAAQc,GACnCD,EAAqBb,EAAM,aAAce,GACzCL,EAAsBV,EAAM,QAASgB,EAAUC,GAC/CJ,EAAqBb,EAAM,cAAekB,GAC1CL,EAAqBb,EAAM,aAAcmB,IAE1CV,EAAaT,EAAM,OAAQC,EAAKmB,MACzBpB,EAcP,SAASQ,EAAUa,EAAK/B,GACvB,IACIgC,EACApB,EACAqB,EACAC,EACJ,IAAMC,EAAsBJ,GAC3B,MAAM,IAAI1B,UAAWC,EAAQ,SAAUyB,IAGxC,GADAG,EAAI,CAAA,EACCpB,UAAUC,OAAS,IACvBH,EAAMd,EAAUoC,EAAGlC,IAElB,MAAMY,EAIR,MAAY,aADZqB,EAAKC,EAAE/B,OAASJ,EAAKI,OAEbiC,EAAUL,EAAKpB,IAGvBqB,EAAM,IADCK,EAAOJ,GACR,CAAUF,GAChBO,EAAS,CAAEN,GAAO,CAAED,GAAO,CAAE,GAAKpB,GAC3BqB,EACP,CAgBD,SAASf,EAAUc,EAAKQ,EAAGC,EAAGxC,GAC7B,IACIgC,EACApB,EACAqB,EACAC,EACJ,IAAMC,EAAsBJ,GAC3B,MAAM,IAAI1B,UAAWC,EAAQ,SAAUyB,IAGxC,GADAG,EAAI,CAAA,EACCpB,UAAUC,OAAS,IACvBH,EAAMd,EAAUoC,EAAGlC,IAElB,MAAMY,EAKR,MAAY,aADZqB,EAAKC,EAAE/B,OAASJ,EAAKI,OAEbiC,EAAUL,EAAKU,IAGvBT,EAAM,IADCK,EAAOJ,GACR,CAAUF,GAChBW,EAAQ,CAAE,CAAEH,GAAK,CAAEC,GAAKR,GAAO,CAAED,GAAO,CAAE,EAAG,EAAG,GAAKpB,GAC9CqB,GAQP,SAASS,IACR,OAAO9B,EAAM4B,EAAGC,EAChB,CACD,CAQD,SAAShB,IACR,OAAOd,EAAKoB,KAAKa,IACjB,CAQD,SAASlB,IACR,OAAOf,EAAKoB,KAAKc,UACjB,CAQD,SAAShB,IACR,OAAOlB,EAAKoB,KAAKe,WACjB,CAQD,SAAShB,IACR,OAAOnB,EAAKoB,KAAKgB,UACjB,CAQD,SAASpB,IACR,OAAOhB,EAAKoB,KAAKiB,KACjB,CASD,SAASpB,EAAUqB,GAClBtC,EAAKoB,KAAKiB,MAAQC,CAClB,CACF,CDrPApD,EAAOqD,KAAM,WEqBV,IAACC,EAAU1C,ICiBdW,EAAAgC,EAAA,UAAA3C"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index abbea01..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From f9ee690f430636b15a8cdb1e6c68e4b7bd7b234e Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 31 Jul 2023 15:10:20 +0000 Subject: [PATCH 23/82] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 62 - .github/workflows/cancel.yml | 56 - .github/workflows/close_pull_requests.yml | 44 - .github/workflows/examples.yml | 62 - .github/workflows/npm_downloads.yml | 108 - .github/workflows/productionize.yml | 798 --- .github/workflows/publish.yml | 242 - .github/workflows/test.yml | 97 - .github/workflows/test_bundles.yml | 180 - .github/workflows/test_coverage.yml | 123 - .github/workflows/test_install.yml | 83 - .gitignore | 188 - .npmignore | 227 - .npmrc | 28 - CHANGELOG.md | 5 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 61 +- benchmark/benchmark.float32.factory.js | 96 - benchmark/benchmark.float32.js | 98 - benchmark/benchmark.float64.factory.js | 96 - benchmark/benchmark.float64.js | 98 - benchmark/benchmark.generic.factory.js | 96 - benchmark/benchmark.generic.js | 98 - branches.md | 53 - docs/repl.txt | 169 - docs/types/test.ts | 355 -- examples/index.js | 48 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/defaults.json | 3 - lib/factory.js | 282 - lib/index.js | 77 - lib/main.js | 58 - lib/validate.js | 72 - package.json | 76 +- stats.html | 6177 +++++++++++++++++++++ test/test.factory.js | 1328 ----- test/test.js | 69 - test/test.main.js | 244 - test/test.validate.js | 118 - 47 files changed, 6215 insertions(+), 6645 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 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 benchmark/benchmark.float32.factory.js delete mode 100644 benchmark/benchmark.float32.js delete mode 100644 benchmark/benchmark.float64.factory.js delete mode 100644 benchmark/benchmark.float64.js delete mode 100644 benchmark/benchmark.generic.factory.js delete mode 100644 benchmark/benchmark.generic.js delete mode 100644 branches.md 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/defaults.json delete mode 100644 lib/factory.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/test.factory.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js delete mode 100644 test/test.validate.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 0fd4d6c..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 `tslint.json` files: -[tslint.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 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 c4ab52b..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/uniform) 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 06a9a75..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,62 +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' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 a00dbe5..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,56 +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' - uses: styfle/cancel-workflow-action@0.11.0 - 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 7eca213..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,44 +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: - run: - runs-on: ubuntu-latest - steps: - - uses: superbrothers/close-pull-request@v3 - 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/uniform) 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 7902a7d..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,62 +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 the repository: - - name: 'Checkout the repository' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 818b9df..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,108 +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: '33 9 * * 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' - uses: actions/checkout@v3 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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' - uses: actions/upload-artifact@v3 - 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' - uses: distributhor/workflow-webhook@v3 - 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 334eb59..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,798 +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' - uses: actions/checkout@v3 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 - - # Format error messages: - - name: 'Replace double quotes with single quotes in rewritten format string error messages' - run: | - find . -name "*.js" -exec sed -E -i "s/Error\( format\( \"([a-zA-Z0-9]+)\"/Error\( format\( '\1'/g" {} \; - - # Format string literal error messages: - - name: 'Replace double quotes with single quotes in rewritten string literal error messages' - run: | - find . -name "*.js" -exec sed -E -i "s/Error\( format\(\"([a-zA-Z0-9]+)\"\)/Error\( format\( '\1' \)/g" {} \; - - # Format code: - - name: 'Replace double quotes with single quotes in inserted `require` calls' - run: | - find . -name "*.js" -exec sed -E -i "s/require\( ?\"@stdlib\/error-tools-fmtprodmsg\" ?\);/require\( '@stdlib\/error-tools-fmtprodmsg' \);/g" {} \; - - # 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' }} - uses: actions/checkout@v3 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - uses: actions/setup-node@v3 - with: - node-version: 16 - 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' - uses: actions/checkout@v3 - - # 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' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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' - uses: act10ns/slack@v2 - 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' - uses: actions/checkout@v3 - - # 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' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 + + ```
@@ -364,7 +363,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]. @@ -424,13 +423,13 @@ Copyright © 2016-2023. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/random-array-uniform/main/LICENSE -[@stdlib/random/base/uniform]: https://github.com/stdlib-js/random-base-uniform +[@stdlib/random/base/uniform]: https://github.com/stdlib-js/random-base-uniform/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/benchmark/benchmark.float32.factory.js b/benchmark/benchmark.float32.factory.js deleted file mode 100644 index 67e61f4..0000000 --- a/benchmark/benchmark.float32.factory.js +++ /dev/null @@ -1,96 +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 bench = require( '@stdlib/bench' ); -var isnanf = require( '@stdlib/math-base-assert-is-nanf' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var fcn = uniform.factory( 2.0, 5.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 4642816..0000000 --- a/benchmark/benchmark.float32.js +++ /dev/null @@ -1,98 +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 bench = require( '@stdlib/bench' ); -var isnanf = require( '@stdlib/math-base-assert-is-nanf' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = 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 = uniform( len, 2.0, 5.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.factory.js b/benchmark/benchmark.float64.factory.js deleted file mode 100644 index 8646a54..0000000 --- a/benchmark/benchmark.float64.factory.js +++ /dev/null @@ -1,96 +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 bench = require( '@stdlib/bench' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var fcn = uniform.factory( 2.0, 5.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 5ee0d97..0000000 --- a/benchmark/benchmark.float64.js +++ /dev/null @@ -1,98 +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 bench = require( '@stdlib/bench' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = 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 = uniform( len, 2.0, 5.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.factory.js b/benchmark/benchmark.generic.factory.js deleted file mode 100644 index 7020d62..0000000 --- a/benchmark/benchmark.generic.factory.js +++ /dev/null @@ -1,96 +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 bench = require( '@stdlib/bench' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var fcn = uniform.factory( 2.0, 5.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 06a2a83..0000000 --- a/benchmark/benchmark.generic.js +++ /dev/null @@ -1,98 +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 bench = require( '@stdlib/bench' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = 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 = uniform( len, 2.0, 5.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 30542fb..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/uniform" -%% click B href "https://github.com/stdlib-js/random-array-uniform/tree/main" -%% click C href "https://github.com/stdlib-js/random-array-uniform/tree/production" -%% click D href "https://github.com/stdlib-js/random-array-uniform/tree/esm" -%% click E href "https://github.com/stdlib-js/random-array-uniform/tree/deno" -%% click F href "https://github.com/stdlib-js/random-array-uniform/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/uniform -[production-url]: https://github.com/stdlib-js/random-array-uniform/tree/production -[deno-url]: https://github.com/stdlib-js/random-array-uniform/tree/deno -[umd-url]: https://github.com/stdlib-js/random-array-uniform/tree/umd -[esm-url]: https://github.com/stdlib-js/random-array-uniform/tree/esm \ No newline at end of file diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 256216a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,169 +0,0 @@ - -{{alias}}( len, a, b[, options] ) - Returns an array containing pseudorandom numbers drawn from a continuous - uniform distribution. - - Parameters - ---------- - len: integer - Output array length. - - a: number - Minimum support. - - b: number - Maximum support. - - 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 ) - - - -{{alias}}.factory( [a, b, ][options] ) - Returns a function for creating arrays containing pseudorandom numbers drawn - from a continuous uniform distribution. - - If provided `a` and `b`, the returned function returns random variates drawn - from the specified distribution. - - If not provided `a` and `b`, the returned function requires that both `a` - and `b` 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. - - 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 ) - - - // Provide distribution parameters: - > fcn = {{alias}}.factory( 2.0, 5.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 ) - - - // Get a copy of the current state: - > var state = {{alias}}.state - - - > out = {{alias}}( 3, 2.0, 5.0 ) - - > out = {{alias}}( 3, 2.0, 5.0 ) - - - // Set the state: - > {{alias}}.state = state; - - // Regenerate a previous array: - > out = {{alias}}( 3, 2.0, 5.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 a087b98..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,355 +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. -*/ - -import random = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - random( 10, 2, 3 ); // $ExpectType RandomArray - random( 10, 1, 2 ); // $ExpectType RandomArray - random( 10, 1, 2, {} ); // $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 ); // $ExpectError - random( true, 2.0, 5.0 ); // $ExpectError - random( false, 2.0, 5.0 ); // $ExpectError - random( null, 2.0, 5.0 ); // $ExpectError - random( [], 2.0, 5.0 ); // $ExpectError - random( {}, 2.0, 5.0 ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - random( '5', 2.0, 5.0, {} ); // $ExpectError - random( true, 2.0, 5.0, {} ); // $ExpectError - random( false, 2.0, 5.0, {} ); // $ExpectError - random( null, 2.0, 5.0, {} ); // $ExpectError - random( [], 2.0, 5.0, {} ); // $ExpectError - random( {}, 2.0, 5.0, {} ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.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 ); // $ExpectError - random( 10, true, 5.0 ); // $ExpectError - random( 10, false, 5.0 ); // $ExpectError - random( 10, null, 5.0 ); // $ExpectError - random( 10, [], 5.0 ); // $ExpectError - random( 10, {}, 5.0 ); // $ExpectError - random( 10, ( x: number ): number => x, 5.0 ); // $ExpectError - - random( 10, '5', 5.0, {} ); // $ExpectError - random( 10, true, 5.0, {} ); // $ExpectError - random( 10, false, 5.0, {} ); // $ExpectError - random( 10, null, 5.0, {} ); // $ExpectError - random( 10, [], 5.0, {} ); // $ExpectError - random( 10, {}, 5.0, {} ); // $ExpectError - random( 10, ( x: number ): number => x, 5.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' ); // $ExpectError - random( 10, 2.0, true ); // $ExpectError - random( 10, 2.0, false ); // $ExpectError - random( 10, 2.0, null ); // $ExpectError - random( 10, 2.0, [] ); // $ExpectError - random( 10, 2.0, {} ); // $ExpectError - random( 10, 2.0, ( x: number ): number => x ); // $ExpectError - - random( 10, 2.0, '5', {} ); // $ExpectError - random( 10, 2.0, true, {} ); // $ExpectError - random( 10, 2.0, false, {} ); // $ExpectError - random( 10, 2.0, null, {} ); // $ExpectError - random( 10, 2.0, [], {} ); // $ExpectError - random( 10, 2.0, {}, {} ); // $ExpectError - random( 10, 2.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, '5' ); // $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, [] ); // $ExpectError - random( 10, 2.0, 5.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, { 'dtype': 123 } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': null } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - random( 10, 2.0, 5.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 -} - -// Attached to main export is a `factory` method which returns a function... -{ - random.factory( 2.0, 5.0 ); // $ExpectType UnaryFunction - random.factory( 2.0, 5.0, { 'copy': false } ); // $ExpectType UnaryFunction - - random.factory(); // $ExpectType TernaryFunction - random.factory( { 'copy': false } ); // $ExpectType TernaryFunction -} - -// The `factory` method returns a function which returns an array... -{ - const fcn1 = random.factory( 2.0, 5.0 ); - fcn1( 10 ); // $ExpectType RandomArray - - const fcn2 = random.factory(); - fcn2( 10, 2.0, 5.0 ); // $ExpectType RandomArray -} - -// The compiler throws an error if the `factory` method is provided invalid arguments... -{ - random.factory( '5', 5.0 ); // $ExpectError - random.factory( true, 5.0 ); // $ExpectError - random.factory( false, 5.0 ); // $ExpectError - random.factory( [], 5.0 ); // $ExpectError - random.factory( {}, 5.0 ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0 ); // $ExpectError - - random.factory( '5', 5.0, {} ); // $ExpectError - random.factory( true, 5.0, {} ); // $ExpectError - random.factory( false, 5.0, {} ); // $ExpectError - random.factory( [], 5.0, {} ); // $ExpectError - random.factory( {}, 5.0, {} ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0, {} ); // $ExpectError - - random.factory( 2.0, '5' ); // $ExpectError - random.factory( 2.0, true ); // $ExpectError - random.factory( 2.0, false ); // $ExpectError - random.factory( 2.0, [] ); // $ExpectError - random.factory( 2.0, {} ); // $ExpectError - random.factory( 2.0, ( x: number ): number => x ); // $ExpectError - - random.factory( 2.0, '5', {} ); // $ExpectError - random.factory( 2.0, true, {} ); // $ExpectError - random.factory( 2.0, false, {} ); // $ExpectError - random.factory( 2.0, [], {} ); // $ExpectError - random.factory( 2.0, {}, {} ); // $ExpectError - random.factory( 2.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, 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, { 'prng': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'seed': true } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': [ 'a' ] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'state': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': {} } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': true ); // $ExpectError - random.factory( 2.0, 5.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, { 'copy': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'dtype': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - random.factory( 2.0, 5.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, {}, {} ); // $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 ); - 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 ); // $ExpectError - fcn2( false, 2.0, 5.0 ); // $ExpectError - fcn2( '5', 2.0, 5.0 ); // $ExpectError - fcn2( [], 2.0, 5.0 ); // $ExpectError - fcn2( {}, 2.0, 5.0 ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - fcn2( true, 2.0, 5.0, {} ); // $ExpectError - fcn2( false, 2.0, 5.0, {} ); // $ExpectError - fcn2( '5', 2.0, 5.0, {} ); // $ExpectError - fcn2( [], 2.0, 5.0, {} ); // $ExpectError - fcn2( {}, 2.0, 5.0, {} ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0, {} ); // $ExpectError - - fcn2( 10, true, 5.0 ); // $ExpectError - fcn2( 10, false, 5.0 ); // $ExpectError - fcn2( 10, '5', 5.0 ); // $ExpectError - fcn2( 10, [], 5.0 ); // $ExpectError - fcn2( 10, {}, 5.0 ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0 ); // $ExpectError - - fcn2( 10, true, 5.0, {} ); // $ExpectError - fcn2( 10, false, 5.0, {} ); // $ExpectError - fcn2( 10, '5', 5.0, {} ); // $ExpectError - fcn2( 10, [], 5.0, {} ); // $ExpectError - fcn2( 10, {}, 5.0, {} ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0, {} ); // $ExpectError - - fcn2( 10, 2.0, true ); // $ExpectError - fcn2( 10, 2.0, false ); // $ExpectError - fcn2( 10, 2.0, '5' ); // $ExpectError - fcn2( 10, 2.0, [] ); // $ExpectError - fcn2( 10, 2.0, {} ); // $ExpectError - fcn2( 10, 2.0, ( x: number ): number => x ); // $ExpectError - - fcn2( 10, 2.0, true, {} ); // $ExpectError - fcn2( 10, 2.0, false, {} ); // $ExpectError - fcn2( 10, 2.0, '5', {} ); // $ExpectError - fcn2( 10, 2.0, [], {} ); // $ExpectError - fcn2( 10, 2.0, {}, {} ); // $ExpectError - fcn2( 10, 2.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, { 'dtype': 123 } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': null } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError - - const fcn2 = random.factory( 2.0, 5.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 ); - fcn1(); // $ExpectError - fcn1( 1, 1, 1 ); // $ExpectError - - const fcn2 = random.factory(); - fcn2(); // $ExpectError - fcn2( 1 ); // $ExpectError - fcn2( 1, 1, 1, 1 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index c485546..0000000 --- a/examples/index.js +++ /dev/null @@ -1,48 +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'; - -var logEach = require( '@stdlib/console-log-each' ); -var uniform = require( './../lib' ); - -// Create a function for generating random arrays originating from the same state: -var random = uniform.factory( 2.0, 5.0, { - 'state': uniform.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 = uniform.factory( 2.0, 5.0, { - 'state': uniform.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 d77d803..9b896f6 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 2.0 -/// +/// import { FloatDataType, 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..a4cb981 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-accessor@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-write-accessor@esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-constant-function@esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-noop@v0.0.14-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/random-base-uniform@esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-typed-real-float-ctors@esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-nullary@esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@esm/index.mjs";import f from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.0.2-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/array-typed-real-float-dtypes@esm/index.mjs";import h from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@esm/index.mjs";var u="float64",c=a();function y(e,t){return h(t)?j(t,"dtype")&&(e.dtype=t.dtype,c.indexOf(e.dtype)<0)?new TypeError(f("null3t","dtype",c.join('", "'),e.dtype)):null:new TypeError(f("null2h",t))}function g(){var a,h,j,c,g,b;if(j={dtype:u},0===(h=arguments.length))g=d,c=x;else if(1===h){if(a=arguments[0],g=d.factory(a),b=y(j,a))throw b;c=x}else if(2===h)g=d.factory(arguments[0],arguments[1]),c=v;else if(3===h){if(a=arguments[2],g=d.factory(arguments[0],arguments[1],a),b=y(j,a))throw b;c=v}return a&&a.prng?(e(c,"seed",null),e(c,"seedLength",null),s(c,"state",r(null),i),e(c,"stateLength",null),e(c,"byteLength",null)):(n(c,"seed",w),n(c,"seedLength",L),s(c,"state",P,R),n(c,"stateLength",G),n(c,"byteLength",N)),e(c,"PRNG",g.PRNG),c;function v(e,n){var s,r,i,d;if(!t(e))throw new TypeError(f("null2p",e));if(d={},arguments.length>1&&(r=y(d,n)))throw r;return"generic"===(i=d.dtype||j.dtype)?l(e,g):(s=new(o(i))(e),m([s],[e],[1],g),s)}function x(e,n,s,r){var i,d,m,a;if(!t(e))throw new TypeError(f("null2p",e));if(a={},arguments.length>3&&(d=y(a,r)))throw d;return"generic"===(m=a.dtype||j.dtype)?l(e,h):(i=new(o(m))(e),p([[n],[s],i],[e],[0,0,1],g),i);function h(){return g(n,s)}}function w(){return c.PRNG.seed}function L(){return c.PRNG.seedLength}function G(){return c.PRNG.stateLength}function N(){return c.PRNG.byteLength}function P(){return c.PRNG.state}function R(e){c.PRNG.state=e}}c.push("generic");var b=g();e(b,"factory",g);export{b as default,g as factory}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..4984bd1 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/factory.js","../lib/main.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 dtypes from '@stdlib/array-typed-real-float-dtypes';\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes();\nDTYPES.push( 'generic' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( 'null2h', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( DTYPES.indexOf( opts.dtype ) < 0 ) {\n\t\t\treturn new TypeError( format( 'null3t', 'dtype', DTYPES.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport setReadOnlyAccessor from '@stdlib/utils-define-nonenumerable-read-only-accessor';\nimport setReadWriteAccessor from '@stdlib/utils-define-nonenumerable-read-write-accessor';\nimport constantFunction from '@stdlib/utils-constant-function';\nimport noop from '@stdlib/utils-noop';\nimport base from '@stdlib/random-base-uniform';\nimport ctors from '@stdlib/array-typed-real-float-ctors';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport nullary from '@stdlib/strided-base-nullary';\nimport binary from '@stdlib/strided-base-binary';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution.\n*\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\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 {RangeError} `a` must be less than `b`\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 uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10 );\n* // returns \n*\n* @example\n* var uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nfunction factory() {\n\tvar options;\n\tvar nargs;\n\tvar opts;\n\tvar rand;\n\tvar prng;\n\tvar err;\n\n\topts = {\n\t\t'dtype': defaults.dtype\n\t};\n\n\tnargs = arguments.length;\n\tif ( nargs === 0 ) {\n\t\tprng = base;\n\t\trand = uniform2;\n\t} else if ( nargs === 1 ) {\n\t\toptions = arguments[ 0 ];\n\t\tprng = base.factory( options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform2;\n\t} else if ( nargs === 2 ) {\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ] );\n\t\trand = uniform1;\n\t} else if ( nargs === 3 ) {\n\t\toptions = arguments[ 2 ];\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ], options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform1;\n\t}\n\tif ( options && options.prng ) {\n\t\tsetReadOnly( rand, 'seed', null );\n\t\tsetReadOnly( rand, 'seedLength', null );\n\t\tsetReadWriteAccessor( rand, 'state', constantFunction( null ), noop );\n\t\tsetReadOnly( rand, 'stateLength', null );\n\t\tsetReadOnly( rand, 'byteLength', null );\n\t} else {\n\t\tsetReadOnlyAccessor( rand, 'seed', getSeed );\n\t\tsetReadOnlyAccessor( rand, 'seedLength', getSeedLength );\n\t\tsetReadWriteAccessor( rand, 'state', getState, setState );\n\t\tsetReadOnlyAccessor( rand, 'stateLength', getStateLength );\n\t\tsetReadOnlyAccessor( rand, 'byteLength', getStateSize );\n\t}\n\tsetReadOnly( rand, 'PRNG', prng.PRNG );\n\treturn rand;\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform1( len, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( 'null2p', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 1 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, prng );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tnullary( [ out ], [ len ], [ 1 ], prng );\n\t\treturn out;\n\t}\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {number} a - minimum support\n\t* @param {number} b - maximum support\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform2( len, a, b, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( 'null2p', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 3 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\t// NOTE: we could alternatively use the PRNG factory function to create a PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. Decision made here to avoid this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom number. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in a return value of `NaN`.\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, wrapper );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tbinary( [ [ a ], [ b ], out ], [ len ], [ 0, 0, 1 ], prng );\n\t\treturn out;\n\n\t\t/**\n\t\t* Applies parameters to a pseudorandom number generator function.\n\t\t*\n\t\t* @private\n\t\t* @returns {number} pseudorandom number\n\t\t*/\n\t\tfunction wrapper() {\n\t\t\treturn prng( a, b );\n\t\t}\n\t}\n\n\t/**\n\t* Returns the PRNG seed.\n\t*\n\t* @private\n\t* @returns {PRNGSeedMT19937} seed\n\t*/\n\tfunction getSeed() {\n\t\treturn rand.PRNG.seed;\n\t}\n\n\t/**\n\t* Returns the PRNG seed length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} seed length\n\t*/\n\tfunction getSeedLength() {\n\t\treturn rand.PRNG.seedLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state length\n\t*/\n\tfunction getStateLength() {\n\t\treturn rand.PRNG.stateLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state size (in bytes).\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state size (in bytes)\n\t*/\n\tfunction getStateSize() {\n\t\treturn rand.PRNG.byteLength;\n\t}\n\n\t/**\n\t* Returns the current pseudorandom number generator state.\n\t*\n\t* @private\n\t* @returns {PRNGStateMT19937} current state\n\t*/\n\tfunction getState() {\n\t\treturn rand.PRNG.state;\n\t}\n\n\t/**\n\t* Sets the pseudorandom number generator state.\n\t*\n\t* @private\n\t* @param {PRNGStateMT19937} s - generator state\n\t* @throws {Error} must provide a valid state\n\t*/\n\tfunction setState( s ) {\n\t\trand.PRNG.state = s;\n\t}\n}\n\n\n// EXPORTS //\n\nexport default factory;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @name uniform\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\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 = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar uniform = factory();\n\n\n// EXPORTS //\n\nexport default uniform;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @module @stdlib/random-array-uniform\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.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\" }\n"],"names":["DTYPES","dtypes","validate","opts","options","isObject","hasOwnProp","dtype","indexOf","TypeError","format","join","factory","nargs","rand","prng","err","defaults","arguments","length","base","uniform2","uniform1","setReadOnly","setReadWriteAccessor","constantFunction","noop","setReadOnlyAccessor","getSeed","getSeedLength","getState","setState","getStateLength","getStateSize","PRNG","len","out","dt","o","isNonNegativeInteger","filledBy","ctors","nullary","a","b","wrapper","binary","seed","seedLength","stateLength","byteLength","state","s","push","uniform","main"],"mappings":";;07CA8BIA,EAASC,IAyBb,SAASC,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,WACzBD,EAAKI,MAAQH,EAAQG,MAChBP,EAAOQ,QAASL,EAAKI,OAAU,GAC5B,IAAIE,UAAWC,EAAQ,SAAU,QAASV,EAAOW,KAAM,QAAUR,EAAKI,QAGxE,KARC,IAAIE,UAAWC,EAAQ,SAAUN,GAS1C,CCSA,SAASQ,IACR,IAAIR,EACAS,EACAV,EACAW,EACAC,EACAC,EAOJ,GALAb,EAAO,CACNI,MAASU,GAIK,KADfJ,EAAQK,UAAUC,QAEjBJ,EAAOK,EACPN,EAAOO,OACD,GAAe,IAAVR,EAAc,CAIzB,GAHAT,EAAUc,UAAW,GACrBH,EAAOK,EAAKR,QAASR,GACrBY,EAAMd,EAAUC,EAAMC,GAErB,MAAMY,EAEPF,EAAOO,CACT,MAAQ,GAAe,IAAVR,EACXE,EAAOK,EAAKR,QAASM,UAAW,GAAKA,UAAW,IAChDJ,EAAOQ,OACD,GAAe,IAAVT,EAAc,CAIzB,GAHAT,EAAUc,UAAW,GACrBH,EAAOK,EAAKR,QAASM,UAAW,GAAKA,UAAW,GAAKd,GACrDY,EAAMd,EAAUC,EAAMC,GAErB,MAAMY,EAEPF,EAAOQ,CACP,CAeD,OAdKlB,GAAWA,EAAQW,MACvBQ,EAAaT,EAAM,OAAQ,MAC3BS,EAAaT,EAAM,aAAc,MACjCU,EAAsBV,EAAM,QAASW,EAAkB,MAAQC,GAC/DH,EAAaT,EAAM,cAAe,MAClCS,EAAaT,EAAM,aAAc,QAEjCa,EAAqBb,EAAM,OAAQc,GACnCD,EAAqBb,EAAM,aAAce,GACzCL,EAAsBV,EAAM,QAASgB,EAAUC,GAC/CJ,EAAqBb,EAAM,cAAekB,GAC1CL,EAAqBb,EAAM,aAAcmB,IAE1CV,EAAaT,EAAM,OAAQC,EAAKmB,MACzBpB,EAcP,SAASQ,EAAUa,EAAK/B,GACvB,IACIgC,EACApB,EACAqB,EACAC,EACJ,IAAMC,EAAsBJ,GAC3B,MAAM,IAAI1B,UAAWC,EAAQ,SAAUyB,IAGxC,GADAG,EAAI,CAAA,EACCpB,UAAUC,OAAS,IACvBH,EAAMd,EAAUoC,EAAGlC,IAElB,MAAMY,EAIR,MAAY,aADZqB,EAAKC,EAAE/B,OAASJ,EAAKI,OAEbiC,EAAUL,EAAKpB,IAGvBqB,EAAM,IADCK,EAAOJ,GACR,CAAUF,GAChBO,EAAS,CAAEN,GAAO,CAAED,GAAO,CAAE,GAAKpB,GAC3BqB,EACP,CAgBD,SAASf,EAAUc,EAAKQ,EAAGC,EAAGxC,GAC7B,IACIgC,EACApB,EACAqB,EACAC,EACJ,IAAMC,EAAsBJ,GAC3B,MAAM,IAAI1B,UAAWC,EAAQ,SAAUyB,IAGxC,GADAG,EAAI,CAAA,EACCpB,UAAUC,OAAS,IACvBH,EAAMd,EAAUoC,EAAGlC,IAElB,MAAMY,EAKR,MAAY,aADZqB,EAAKC,EAAE/B,OAASJ,EAAKI,OAEbiC,EAAUL,EAAKU,IAGvBT,EAAM,IADCK,EAAOJ,GACR,CAAUF,GAChBW,EAAQ,CAAE,CAAEH,GAAK,CAAEC,GAAKR,GAAO,CAAED,GAAO,CAAE,EAAG,EAAG,GAAKpB,GAC9CqB,GAQP,SAASS,IACR,OAAO9B,EAAM4B,EAAGC,EAChB,CACD,CAQD,SAAShB,IACR,OAAOd,EAAKoB,KAAKa,IACjB,CAQD,SAASlB,IACR,OAAOf,EAAKoB,KAAKc,UACjB,CAQD,SAAShB,IACR,OAAOlB,EAAKoB,KAAKe,WACjB,CAQD,SAAShB,IACR,OAAOnB,EAAKoB,KAAKgB,UACjB,CAQD,SAASpB,IACR,OAAOhB,EAAKoB,KAAKiB,KACjB,CASD,SAASpB,EAAUqB,GAClBtC,EAAKoB,KAAKiB,MAAQC,CAClB,CACF,CDrPApD,EAAOqD,KAAM,WEqBV,IAACC,EAAU1C,ICiBdW,EAAAgC,EAAA,UAAA3C"} \ No newline at end of file diff --git a/lib/defaults.json b/lib/defaults.json deleted file mode 100644 index 83f4438..0000000 --- a/lib/defaults.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "dtype": "float64" -} diff --git a/lib/factory.js b/lib/factory.js deleted file mode 100644 index 9f232af..0000000 --- a/lib/factory.js +++ /dev/null @@ -1,282 +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 isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var setReadOnlyAccessor = require( '@stdlib/utils-define-nonenumerable-read-only-accessor' ); -var setReadWriteAccessor = require( '@stdlib/utils-define-nonenumerable-read-write-accessor' ); -var constantFunction = require( '@stdlib/utils-constant-function' ); -var noop = require( '@stdlib/utils-noop' ); -var base = require( '@stdlib/random-base-uniform' ); -var ctors = require( '@stdlib/array-typed-real-float-ctors' ); -var filledBy = require( '@stdlib/array-base-filled-by' ); -var nullary = require( '@stdlib/strided-base-nullary' ); -var binary = require( '@stdlib/strided-base-binary' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution. -* -* @param {number} [a] - minimum support -* @param {number} [b] - maximum support -* @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 {RangeError} `a` must be less than `b` -* @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 uniform = factory( 2.0, 5.0 ); -* // returns -* -* var arr = uniform( 10 ); -* // returns -* -* @example -* var uniform = factory( 2.0, 5.0 ); -* // returns -* -* var arr = uniform( 10, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -function factory() { - var options; - var nargs; - var opts; - var rand; - var prng; - var err; - - opts = { - 'dtype': defaults.dtype - }; - - nargs = arguments.length; - if ( nargs === 0 ) { - prng = base; - rand = uniform2; - } else if ( nargs === 1 ) { - options = arguments[ 0 ]; - prng = base.factory( options ); - err = validate( opts, options ); - if ( err ) { - throw err; - } - rand = uniform2; - } else if ( nargs === 2 ) { - prng = base.factory( arguments[ 0 ], arguments[ 1 ] ); - rand = uniform1; - } else if ( nargs === 3 ) { - options = arguments[ 2 ]; - prng = base.factory( arguments[ 0 ], arguments[ 1 ], options ); - err = validate( opts, options ); - if ( err ) { - throw err; - } - rand = uniform1; - } - if ( options && options.prng ) { - setReadOnly( rand, 'seed', null ); - setReadOnly( rand, 'seedLength', null ); - setReadWriteAccessor( rand, 'state', constantFunction( null ), noop ); - setReadOnly( rand, 'stateLength', null ); - setReadOnly( rand, 'byteLength', null ); - } else { - setReadOnlyAccessor( rand, 'seed', getSeed ); - setReadOnlyAccessor( rand, 'seedLength', getSeedLength ); - setReadWriteAccessor( rand, 'state', getState, setState ); - setReadOnlyAccessor( rand, 'stateLength', getStateLength ); - setReadOnlyAccessor( rand, 'byteLength', getStateSize ); - } - setReadOnly( rand, 'PRNG', prng.PRNG ); - return rand; - - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @private - * @param {NonNegativeInteger} len - array length - * @param {Options} [options] - function options - * @param {string} [options.dtype] - 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 - */ - function uniform1( len, options ) { - var ctor; - var out; - var err; - var dt; - var o; - if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( 'null2p', len ) ); - } - o = {}; - if ( arguments.length > 1 ) { - err = validate( o, options ); - if ( err ) { - throw err; - } - } - dt = o.dtype || opts.dtype; - if ( dt === 'generic' ) { - return filledBy( len, prng ); - } - ctor = ctors( dt ); - out = new ctor( len ); - nullary( [ out ], [ len ], [ 1 ], prng ); - return out; - } - - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @private - * @param {NonNegativeInteger} len - array length - * @param {number} a - minimum support - * @param {number} b - maximum support - * @param {Options} [options] - function options - * @param {string} [options.dtype] - 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 - */ - function uniform2( len, a, b, options ) { - var ctor; - var out; - var err; - var dt; - var o; - if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( 'null2p', len ) ); - } - o = {}; - if ( arguments.length > 3 ) { - err = validate( o, options ); - if ( err ) { - throw err; - } - } - // NOTE: we could alternatively use the PRNG factory function to create a PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. Decision made here to avoid this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom number. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in a return value of `NaN`. - dt = o.dtype || opts.dtype; - if ( dt === 'generic' ) { - return filledBy( len, wrapper ); - } - ctor = ctors( dt ); - out = new ctor( len ); - binary( [ [ a ], [ b ], out ], [ len ], [ 0, 0, 1 ], prng ); - return out; - - /** - * Applies parameters to a pseudorandom number generator function. - * - * @private - * @returns {number} pseudorandom number - */ - function wrapper() { - return prng( a, b ); - } - } - - /** - * Returns the PRNG seed. - * - * @private - * @returns {PRNGSeedMT19937} seed - */ - function getSeed() { - return rand.PRNG.seed; - } - - /** - * Returns the PRNG seed length. - * - * @private - * @returns {PositiveInteger} seed length - */ - function getSeedLength() { - return rand.PRNG.seedLength; - } - - /** - * Returns the PRNG state length. - * - * @private - * @returns {PositiveInteger} state length - */ - function getStateLength() { - return rand.PRNG.stateLength; - } - - /** - * Returns the PRNG state size (in bytes). - * - * @private - * @returns {PositiveInteger} state size (in bytes) - */ - function getStateSize() { - return rand.PRNG.byteLength; - } - - /** - * Returns the current pseudorandom number generator state. - * - * @private - * @returns {PRNGStateMT19937} current state - */ - function getState() { - return rand.PRNG.state; - } - - /** - * Sets the pseudorandom number generator state. - * - * @private - * @param {PRNGStateMT19937} s - generator state - * @throws {Error} must provide a valid state - */ - function setState( s ) { - rand.PRNG.state = s; - } -} - - -// EXPORTS // - -module.exports = factory; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 0077f00..0000000 --- a/lib/index.js +++ /dev/null @@ -1,77 +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'; - -/** -* Create an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. -* -* @module @stdlib/random-array-uniform -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var arr = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var arr = uniform( 10, 2.0, 5.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var rand = uniform.factory( 2.0, 5.0 ); -* // returns -* -* var arr = rand( 10 ); -* // returns -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var rand = uniform.factory( 2.0, 5.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" } diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index da0d9b1..0000000 --- a/lib/main.js +++ /dev/null @@ -1,58 +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 factory = require( './factory.js' ); - - -// MAIN // - -/** -* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. -* -* @name uniform -* @type {Function} -* @param {NonNegativeInteger} len - array length -* @param {number} a - minimum support -* @param {number} b - maximum support -* @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 = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var arr = uniform( 10, 2.0, 5.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -var uniform = factory(); - - -// EXPORTS // - -module.exports = uniform; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index 3629aaf..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,72 +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 dtypes = require( '@stdlib/array-typed-real-float-dtypes' ); -var isObject = require( '@stdlib/assert-is-plain-object' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// VARIABLES // - -var DTYPES = dtypes(); -DTYPES.push( 'generic' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Options} options - function options -* @param {string} [options.dtype] - output array data type -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var options = { -* 'dtype': 'float64' -* }; -* var err = validate( opts, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( 'null2h', options ) ); - } - if ( hasOwnProp( options, 'dtype' ) ) { - opts.dtype = options.dtype; - if ( DTYPES.indexOf( opts.dtype ) < 0 ) { - return new TypeError( format( 'null3t', 'dtype', DTYPES.join( '", "' ), opts.dtype ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index 0950c02..c34faa6 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.0.1", "description": "Create an array containing pseudorandom numbers drawn from a continuous uniform 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,55 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-filled-by": "^0.0.2", - "@stdlib/array-typed-real-float-ctors": "^0.0.1", - "@stdlib/array-typed-real-float-dtypes": "^0.0.1", - "@stdlib/assert-has-own-property": "^0.0.7", - "@stdlib/assert-is-nonnegative-integer": "^0.0.7", - "@stdlib/assert-is-plain-object": "^0.0.7", - "@stdlib/random-base-uniform": "^0.0.6", - "@stdlib/strided-base-binary": "^0.0.8", - "@stdlib/strided-base-nullary": "^0.0.7", - "@stdlib/error-tools-fmtprodmsg": "^0.0.2", - "@stdlib/types": "^0.0.14", - "@stdlib/utils-constant-function": "^0.0.8", - "@stdlib/utils-define-nonenumerable-read-only-accessor": "^0.0.7", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.7", - "@stdlib/utils-define-nonenumerable-read-write-accessor": "^0.0.7", - "@stdlib/utils-noop": "^0.0.14" - }, - "devDependencies": { - "@stdlib/array-float32": "^0.0.6", - "@stdlib/array-float64": "^0.0.6", - "@stdlib/array-uint32": "^0.0.6", - "@stdlib/assert-is-uint32array": "^0.0.8", - "@stdlib/bench": "^0.0.12", - "@stdlib/console-log-each": "^0.0.2", - "@stdlib/constants-uint32-max": "^0.0.7", - "@stdlib/math-base-assert-is-nan": "^0.0.8", - "@stdlib/math-base-assert-is-nanf": "^0.0.8", - "@stdlib/math-base-special-pow": "^0.0.7", - "@stdlib/random-base-minstd": "^0.0.6", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdmath", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..efe47ca --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/test.factory.js b/test/test.factory.js deleted file mode 100644 index a869e75..0000000 --- a/test/test.factory.js +++ /dev/null @@ -1,1328 +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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -tape( 'the function throws an error if the second distribution parameter is less than the first distribution parameter', function test( t ) { - var values; - var i; - - values = [ - [ 0.0, 0.0 ], - [ -2.0, -4.0 ], - [ 2.0, 1.0 ] - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( arr ) { - return function badValue() { - factory( arr[0], arr[1] ); - }; - } -}); - -tape( 'the function throws an error if the second distribution parameter is less than the first distribution parameter (options)', function test( t ) { - var values; - var i; - - values = [ - [ 0.0, 0.0 ], - [ -2.0, -4.0 ], - [ 2.0, 1.0 ] - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( arr ) { - return function badValue() { - factory( arr[0], arr[1], {} ); - }; - } -}); - -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, 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, { - '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, { - '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, { - '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, { - '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, { - '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, { - '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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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 ); - - 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 ); - - 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, { - '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 ); - - 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 ); - 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( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory(); - actual = random( 10, 2.0, 5.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( typeof actual[ i ], 'number', '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 ); - - 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 ); - - 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 ); - - 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 that generates `NaN` values if the first distribution parameter is greater than or equal to the second distribution parameter', function test( t ) { - var random; - var values; - var actual; - var i; - var j; - - random = factory(); - values = [ - [ 2.0, 1.0 ], - [ -3.0, -4.0 ], - [ 0.0, 0.0 ] - ]; - - for ( i = 0; i < values.length; i++ ) { - actual = random( 10, values[ i ][ 0 ], values[ i ][ 1 ] ); - for ( j = 0; j < actual.length; j++ ) { - t.strictEqual( isnan( actual[ j ] ), true, 'returns expected value when provided '+values[ 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, { - '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 ); - - 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, { - '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( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'float64' - }); - actual = random( 10, 2.0, 5.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( typeof actual[ i ], 'number', '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, { - '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( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'float32' - }); - actual = random( 10, 2.0, 5.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( typeof actual[ i ], 'number', '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, { - '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 ); - - 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, { - '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, { - '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 ); - - // 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, { - '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 ); - - // 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, { - '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 ); - - 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, { - 'prng': randu.normalized - }); - - randu = minstd.factory({ - 'seed': seed - }); - random2 = factory( 2.0, 5.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 ); - arr2 = random2( 10, 2.0, 5.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 c4fb6d3..0000000 --- a/test/test.js +++ /dev/null @@ -1,69 +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 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 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 37b0080..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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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, 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, { - '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 ); - - 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( typeof actual[ i ], 'number', '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, { - '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( typeof actual[ i ], 'number', '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, { - '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( typeof actual[ i ], 'number', '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, { - '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 ); - } - // Capture the current state: - state = random.state; - - // Move to a future state... - arr = random( 10, 2.0, 5.0 ); - for ( i = 0; i < 100; i++ ) { - random( 2, 2.0, 5.0 ); - } - // Set the state: - random.state = state; - - // Replay previously generated values: - t.deepEqual( random( 10, 2.0, 5.0 ), arr, 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.validate.js b/test/test.validate.js deleted file mode 100644 index 9fbe15f..0000000 --- a/test/test.validate.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 validate = require( './../lib/validate.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof validate, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function returns an error if provided an options argument which is not an object', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - void 0, - null, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, values[ i ] ); - t.equal( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided a `dtype` option which is not a supported data type', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - -5, - NaN, - true, - false, - void 0, - null, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, { - 'dtype': values[ i ] - }); - t.equal( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns null if all options are valid', function test( t ) { - var options; - var opts; - var err; - - options = { - 'dtype': 'float64' - }; - opts = {}; - err = validate( opts, options ); - - t.equal( err, null, 'returns null' ); - t.deepEqual( opts, options, 'sets option values' ); - - t.end(); -}); - -tape( 'the function ignores unrecognized/unsupported options', function test( t ) { - var options; - var opts; - var err; - - options = { - 'beep': true, - 'boop': 'bop' - }; - opts = {}; - err = validate( opts, options ); - - t.equal( err, null, 'returns null' ); - t.deepEqual( opts, {}, 'does not set any option values' ); - t.end(); -}); From d451f97f0066ffefc0d26848e2b47f3da545b55a Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 31 Jul 2023 15:11:19 +0000 Subject: [PATCH 24/82] Update README.md for ESM bundle v0.0.1 --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index bf66901..bbb7032 100644 --- a/README.md +++ b/README.md @@ -31,13 +31,13 @@ limitations under the License. ## Usage ```javascript -import uniform from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-uniform@esm/index.mjs'; +import uniform from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-uniform@v0.0.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-uniform@esm/index.mjs'; +import { factory } from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-uniform@v0.0.1-esm/index.mjs'; ``` #### uniform( len, a, b\[, options] ) @@ -309,7 +309,7 @@ var sz = random.byteLength; - - - - From 031513a271b98822c04d0402d99c0ba11582d35e Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 24 Sep 2023 21:57:01 +0000 Subject: [PATCH 28/82] Auto-generated commit --- .editorconfig | 186 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 62 - .github/workflows/cancel.yml | 56 - .github/workflows/close_pull_requests.yml | 44 - .github/workflows/examples.yml | 62 - .github/workflows/npm_downloads.yml | 108 - .github/workflows/productionize.yml | 783 --- .github/workflows/publish.yml | 242 - .github/workflows/test.yml | 97 - .github/workflows/test_bundles.yml | 180 - .github/workflows/test_coverage.yml | 123 - .github/workflows/test_install.yml | 83 - .gitignore | 188 - .npmignore | 227 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 61 +- benchmark/benchmark.float32.factory.js | 96 - benchmark/benchmark.float32.js | 98 - benchmark/benchmark.float64.factory.js | 96 - benchmark/benchmark.float64.js | 98 - benchmark/benchmark.generic.factory.js | 96 - benchmark/benchmark.generic.js | 98 - branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 9 - dist/index.js.map | 7 - docs/repl.txt | 169 - docs/types/test.ts | 355 -- examples/index.js | 48 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/defaults.json | 3 - lib/factory.js | 282 - lib/index.js | 77 - lib/main.js | 58 - lib/validate.js | 72 - package.json | 76 +- stats.html | 6177 +++++++++++++++++++++ test/test.factory.js | 1328 ----- test/test.js | 69 - test/test.main.js | 244 - test/test.validate.js | 118 - 51 files changed, 6215 insertions(+), 6684 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 benchmark/benchmark.float32.factory.js delete mode 100644 benchmark/benchmark.float32.js delete mode 100644 benchmark/benchmark.float64.factory.js delete mode 100644 benchmark/benchmark.float64.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/defaults.json delete mode 100644 lib/factory.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/test.factory.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js delete mode 100644 test/test.validate.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 13e9c39..0000000 --- a/.editorconfig +++ /dev/null @@ -1,186 +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 `tslint.json` files: -[tslint.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 c4ab52b..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/uniform) 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 06a9a75..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,62 +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' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 a00dbe5..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,56 +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' - uses: styfle/cancel-workflow-action@0.11.0 - 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 7eca213..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,44 +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: - run: - runs-on: ubuntu-latest - steps: - - uses: superbrothers/close-pull-request@v3 - 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/uniform) 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 7902a7d..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,62 +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 the repository: - - name: 'Checkout the repository' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 818b9df..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,108 +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: '33 9 * * 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' - uses: actions/checkout@v3 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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' - uses: actions/upload-artifact@v3 - 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' - uses: distributhor/workflow-webhook@v3 - 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 91f2b93..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,783 +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' - uses: actions/checkout@v3 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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' }} - uses: actions/checkout@v3 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - uses: actions/setup-node@v3 - with: - node-version: 16 - 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' - uses: actions/checkout@v3 - - # 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' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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' - uses: act10ns/slack@v2 - 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' - uses: actions/checkout@v3 - - # 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' - uses: actions/setup-node@v3 - with: - node-version: 16 - 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 + + ```
@@ -375,7 +374,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]. @@ -435,13 +434,13 @@ Copyright © 2016-2023. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/random-array-uniform/main/LICENSE -[@stdlib/random/base/uniform]: https://github.com/stdlib-js/random-base-uniform +[@stdlib/random/base/uniform]: https://github.com/stdlib-js/random-base-uniform/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/benchmark/benchmark.float32.factory.js b/benchmark/benchmark.float32.factory.js deleted file mode 100644 index 67e61f4..0000000 --- a/benchmark/benchmark.float32.factory.js +++ /dev/null @@ -1,96 +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 bench = require( '@stdlib/bench' ); -var isnanf = require( '@stdlib/math-base-assert-is-nanf' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var fcn = uniform.factory( 2.0, 5.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 4642816..0000000 --- a/benchmark/benchmark.float32.js +++ /dev/null @@ -1,98 +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 bench = require( '@stdlib/bench' ); -var isnanf = require( '@stdlib/math-base-assert-is-nanf' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = 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 = uniform( len, 2.0, 5.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.factory.js b/benchmark/benchmark.float64.factory.js deleted file mode 100644 index 8646a54..0000000 --- a/benchmark/benchmark.float64.factory.js +++ /dev/null @@ -1,96 +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 bench = require( '@stdlib/bench' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var fcn = uniform.factory( 2.0, 5.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 5ee0d97..0000000 --- a/benchmark/benchmark.float64.js +++ /dev/null @@ -1,98 +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 bench = require( '@stdlib/bench' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = 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 = uniform( len, 2.0, 5.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.factory.js b/benchmark/benchmark.generic.factory.js deleted file mode 100644 index 7020d62..0000000 --- a/benchmark/benchmark.generic.factory.js +++ /dev/null @@ -1,96 +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 bench = require( '@stdlib/bench' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var fcn = uniform.factory( 2.0, 5.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 06a2a83..0000000 --- a/benchmark/benchmark.generic.js +++ /dev/null @@ -1,98 +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 bench = require( '@stdlib/bench' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = 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 = uniform( len, 2.0, 5.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 30542fb..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/uniform" -%% click B href "https://github.com/stdlib-js/random-array-uniform/tree/main" -%% click C href "https://github.com/stdlib-js/random-array-uniform/tree/production" -%% click D href "https://github.com/stdlib-js/random-array-uniform/tree/esm" -%% click E href "https://github.com/stdlib-js/random-array-uniform/tree/deno" -%% click F href "https://github.com/stdlib-js/random-array-uniform/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/uniform -[production-url]: https://github.com/stdlib-js/random-array-uniform/tree/production -[deno-url]: https://github.com/stdlib-js/random-array-uniform/tree/deno -[umd-url]: https://github.com/stdlib-js/random-array-uniform/tree/umd -[esm-url]: https://github.com/stdlib-js/random-array-uniform/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 f2a679f..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import uniform from '../docs/types/index'; -export = uniform; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 0ef1443..0000000 --- a/dist/index.js +++ /dev/null @@ -1,9 +0,0 @@ -"use strict";var y=function(t,r){return function(){return r||t((r={exports:{}}).exports,r),r.exports}};var b=y(function(ue,H){H.exports={dtype:"float64"}});var O=y(function(se,G){ -var J=require('@stdlib/array-typed-real-float-dtypes/dist'),K=require('@stdlib/assert-is-plain-object/dist'),M=require('@stdlib/assert-has-own-property/dist'),N=require('@stdlib/error-tools-fmtprodmsg/dist'),w=J();w.push("generic");function Q(t,r){return K(r)?M(r,"dtype")&&(t.dtype=r.dtype,w.indexOf(t.dtype)<0)?new TypeError(N('1eR4S',"dtype",w.join('", "'),t.dtype)):null:new TypeError(N('1eR2V',r));}G.exports=Q -});var R=y(function(oe,F){ -var S=require('@stdlib/assert-is-nonnegative-integer/dist').isPrimitive,d=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),l=require('@stdlib/utils-define-nonenumerable-read-only-accessor/dist'),x=require('@stdlib/utils-define-nonenumerable-read-write-accessor/dist'),U=require('@stdlib/utils-constant-function/dist'),X=require('@stdlib/utils-noop/dist'),p=require('@stdlib/random-base-uniform/dist'),E=require('@stdlib/array-typed-real-float-ctors/dist'),T=require('@stdlib/array-base-filled-by/dist'),Z=require('@stdlib/strided-base-nullary/dist'),_=require('@stdlib/strided-base-binary/dist'),j=require('@stdlib/error-tools-fmtprodmsg/dist'),$=b(),m=O();function ee(){var t,r,v,e,a,s;if(v={dtype:$.dtype},r=arguments.length,r===0)a=p,e=P;else if(r===1){if(t=arguments[0],a=p.factory(t),s=m(v,t),s)throw s;e=P}else if(r===2)a=p.factory(arguments[0],arguments[1]),e=L;else if(r===3){if(t=arguments[2],a=p.factory(arguments[0],arguments[1],t),s=m(v,t),s)throw s;e=L}return t&&t.prng?(d(e,"seed",null),d(e,"seedLength",null),x(e,"state",U(null),X),d(e,"stateLength",null),d(e,"byteLength",null)):(l(e,"seed",B),l(e,"seedLength",D),x(e,"state",Y,k),l(e,"stateLength",I),l(e,"byteLength",W)),d(e,"PRNG",a.PRNG),e;function L(n,c){var f,g,o,i,u;if(!S(n))throw new TypeError(j('1eR2d',n));if(u={},arguments.length>1&&(o=m(u,c),o))throw o;return i=u.dtype||v.dtype,i==="generic"?T(n,a):(f=E(i),g=new f(n),Z([g],[n],[1],a),g)}function P(n,c,f,g){var o,i,u,h,q;if(!S(n))throw new TypeError(j('1eR2d',n));if(q={},arguments.length>3&&(u=m(q,g),u))throw u;if(h=q.dtype||v.dtype,h==="generic")return T(n,C);return o=E(h),i=new o(n),_([[c],[f],i],[n],[0,0,1],a),i;function C(){return a(c,f)}}function B(){return e.PRNG.seed}function D(){return e.PRNG.seedLength}function I(){return e.PRNG.stateLength}function W(){return e.PRNG.byteLength}function Y(){return e.PRNG.state}function k(n){e.PRNG.state=n}}F.exports=ee -});var A=y(function(ve,V){ -var re=R(),te=re();V.exports=te -});var ne=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),z=A(),ae=R();ne(z,"factory",ae);module.exports=z; -/** @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 fcb8851..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/defaults.json", "../lib/validate.js", "../lib/factory.js", "../lib/main.js", "../lib/index.js"], - "sourcesContent": ["{\n\t\"dtype\": \"float64\"\n}\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 dtypes = require( '@stdlib/array-typed-real-float-dtypes' );\nvar isObject = require( '@stdlib/assert-is-plain-object' );\nvar hasOwnProp = require( '@stdlib/assert-has-own-property' );\nvar format = require( '@stdlib/string-format' );\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes();\nDTYPES.push( 'generic' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( DTYPES.indexOf( opts.dtype ) < 0 ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be one of the following: \"%s\". Option: `%s`.', 'dtype', DTYPES.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nmodule.exports = validate;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive;\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar setReadOnlyAccessor = require( '@stdlib/utils-define-nonenumerable-read-only-accessor' );\nvar setReadWriteAccessor = require( '@stdlib/utils-define-nonenumerable-read-write-accessor' );\nvar constantFunction = require( '@stdlib/utils-constant-function' );\nvar noop = require( '@stdlib/utils-noop' );\nvar base = require( '@stdlib/random-base-uniform' );\nvar ctors = require( '@stdlib/array-typed-real-float-ctors' );\nvar filledBy = require( '@stdlib/array-base-filled-by' );\nvar nullary = require( '@stdlib/strided-base-nullary' );\nvar binary = require( '@stdlib/strided-base-binary' );\nvar format = require( '@stdlib/string-format' );\nvar defaults = require( './defaults.json' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution.\n*\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\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 {RangeError} `a` must be less than `b`\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 uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10 );\n* // returns \n*\n* @example\n* var uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nfunction factory() {\n\tvar options;\n\tvar nargs;\n\tvar opts;\n\tvar rand;\n\tvar prng;\n\tvar err;\n\n\topts = {\n\t\t'dtype': defaults.dtype\n\t};\n\n\tnargs = arguments.length;\n\tif ( nargs === 0 ) {\n\t\tprng = base;\n\t\trand = uniform2;\n\t} else if ( nargs === 1 ) {\n\t\toptions = arguments[ 0 ];\n\t\tprng = base.factory( options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform2;\n\t} else if ( nargs === 2 ) {\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ] );\n\t\trand = uniform1;\n\t} else if ( nargs === 3 ) {\n\t\toptions = arguments[ 2 ];\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ], options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform1;\n\t}\n\tif ( options && options.prng ) {\n\t\tsetReadOnly( rand, 'seed', null );\n\t\tsetReadOnly( rand, 'seedLength', null );\n\t\tsetReadWriteAccessor( rand, 'state', constantFunction( null ), noop );\n\t\tsetReadOnly( rand, 'stateLength', null );\n\t\tsetReadOnly( rand, 'byteLength', null );\n\t} else {\n\t\tsetReadOnlyAccessor( rand, 'seed', getSeed );\n\t\tsetReadOnlyAccessor( rand, 'seedLength', getSeedLength );\n\t\tsetReadWriteAccessor( rand, 'state', getState, setState );\n\t\tsetReadOnlyAccessor( rand, 'stateLength', getStateLength );\n\t\tsetReadOnlyAccessor( rand, 'byteLength', getStateSize );\n\t}\n\tsetReadOnly( rand, 'PRNG', prng.PRNG );\n\treturn rand;\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform1( len, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 1 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, prng );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tnullary( [ out ], [ len ], [ 1 ], prng );\n\t\treturn out;\n\t}\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {number} a - minimum support\n\t* @param {number} b - maximum support\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform2( len, a, b, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 3 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\t// NOTE: we could alternatively use the PRNG factory function to create a PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. Decision made here to avoid this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom number. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in a return value of `NaN`.\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, wrapper );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tbinary( [ [ a ], [ b ], out ], [ len ], [ 0, 0, 1 ], prng );\n\t\treturn out;\n\n\t\t/**\n\t\t* Applies parameters to a pseudorandom number generator function.\n\t\t*\n\t\t* @private\n\t\t* @returns {number} pseudorandom number\n\t\t*/\n\t\tfunction wrapper() {\n\t\t\treturn prng( a, b );\n\t\t}\n\t}\n\n\t/**\n\t* Returns the PRNG seed.\n\t*\n\t* @private\n\t* @returns {PRNGSeedMT19937} seed\n\t*/\n\tfunction getSeed() {\n\t\treturn rand.PRNG.seed;\n\t}\n\n\t/**\n\t* Returns the PRNG seed length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} seed length\n\t*/\n\tfunction getSeedLength() {\n\t\treturn rand.PRNG.seedLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state length\n\t*/\n\tfunction getStateLength() {\n\t\treturn rand.PRNG.stateLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state size (in bytes).\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state size (in bytes)\n\t*/\n\tfunction getStateSize() {\n\t\treturn rand.PRNG.byteLength;\n\t}\n\n\t/**\n\t* Returns the current pseudorandom number generator state.\n\t*\n\t* @private\n\t* @returns {PRNGStateMT19937} current state\n\t*/\n\tfunction getState() {\n\t\treturn rand.PRNG.state;\n\t}\n\n\t/**\n\t* Sets the pseudorandom number generator state.\n\t*\n\t* @private\n\t* @param {PRNGStateMT19937} s - generator state\n\t* @throws {Error} must provide a valid state\n\t*/\n\tfunction setState( s ) {\n\t\trand.PRNG.state = s;\n\t}\n}\n\n\n// EXPORTS //\n\nmodule.exports = factory;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @name uniform\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\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 = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar uniform = factory();\n\n\n// EXPORTS //\n\nmodule.exports = uniform;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @module @stdlib/random-array-uniform\n*\n* @example\n* var uniform = require( '@stdlib/random-array-uniform' );\n*\n* var arr = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var uniform = require( '@stdlib/random-array-uniform' );\n*\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* var uniform = require( '@stdlib/random-array-uniform' );\n*\n* var rand = uniform.factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* var uniform = require( '@stdlib/random-array-uniform' );\n*\n* var rand = uniform.factory( 2.0, 5.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\" }\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,GAAAC,EAAA,CAAAA,EAAA,SACC,MAAS,SACV,ICFA,IAAAC,EAAAC,EAAA,SAAAC,GAAAC,EAAA,cAsBA,IAAIC,EAAS,QAAS,uCAAwC,EAC1DC,EAAW,QAAS,gCAAiC,EACrDC,EAAa,QAAS,iCAAkC,EACxDC,EAAS,QAAS,uBAAwB,EAK1CC,EAASJ,EAAO,EACpBI,EAAO,KAAM,SAAU,EAwBvB,SAASC,EAAUC,EAAMC,EAAU,CAClC,OAAMN,EAAUM,CAAQ,EAGnBL,EAAYK,EAAS,OAAQ,IACjCD,EAAK,MAAQC,EAAQ,MAChBH,EAAO,QAASE,EAAK,KAAM,EAAI,GAC5B,IAAI,UAAWH,EAAQ,gFAAiF,QAASC,EAAO,KAAM,MAAO,EAAGE,EAAK,KAAM,CAAE,EAGvJ,KARC,IAAI,UAAWH,EAAQ,qEAAsEI,CAAQ,CAAE,CAShH,CAKAR,EAAO,QAAUM,ICvEjB,IAAAG,EAAAC,EAAA,SAAAC,GAAAC,EAAA,cAsBA,IAAIC,EAAuB,QAAS,uCAAwC,EAAE,YAC1EC,EAAc,QAAS,uDAAwD,EAC/EC,EAAsB,QAAS,uDAAwD,EACvFC,EAAuB,QAAS,wDAAyD,EACzFC,EAAmB,QAAS,iCAAkC,EAC9DC,EAAO,QAAS,oBAAqB,EACrCC,EAAO,QAAS,6BAA8B,EAC9CC,EAAQ,QAAS,sCAAuC,EACxDC,EAAW,QAAS,8BAA+B,EACnDC,EAAU,QAAS,8BAA+B,EAClDC,EAAS,QAAS,6BAA8B,EAChDC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IACXC,EAAW,IAwCf,SAASC,IAAU,CAClB,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EAOJ,GALAH,EAAO,CACN,MAASL,EAAS,KACnB,EAEAI,EAAQ,UAAU,OACbA,IAAU,EACdG,EAAOb,EACPY,EAAOG,UACIL,IAAU,EAAI,CAIzB,GAHAD,EAAU,UAAW,CAAE,EACvBI,EAAOb,EAAK,QAASS,CAAQ,EAC7BK,EAAMP,EAAUI,EAAMF,CAAQ,EACzBK,EACJ,MAAMA,EAEPF,EAAOG,CACR,SAAYL,IAAU,EACrBG,EAAOb,EAAK,QAAS,UAAW,CAAE,EAAG,UAAW,CAAE,CAAE,EACpDY,EAAOI,UACIN,IAAU,EAAI,CAIzB,GAHAD,EAAU,UAAW,CAAE,EACvBI,EAAOb,EAAK,QAAS,UAAW,CAAE,EAAG,UAAW,CAAE,EAAGS,CAAQ,EAC7DK,EAAMP,EAAUI,EAAMF,CAAQ,EACzBK,EACJ,MAAMA,EAEPF,EAAOI,CACR,CACA,OAAKP,GAAWA,EAAQ,MACvBd,EAAaiB,EAAM,OAAQ,IAAK,EAChCjB,EAAaiB,EAAM,aAAc,IAAK,EACtCf,EAAsBe,EAAM,QAASd,EAAkB,IAAK,EAAGC,CAAK,EACpEJ,EAAaiB,EAAM,cAAe,IAAK,EACvCjB,EAAaiB,EAAM,aAAc,IAAK,IAEtChB,EAAqBgB,EAAM,OAAQK,CAAQ,EAC3CrB,EAAqBgB,EAAM,aAAcM,CAAc,EACvDrB,EAAsBe,EAAM,QAASO,EAAUC,CAAS,EACxDxB,EAAqBgB,EAAM,cAAeS,CAAe,EACzDzB,EAAqBgB,EAAM,aAAcU,CAAa,GAEvD3B,EAAaiB,EAAM,OAAQC,EAAK,IAAK,EAC9BD,EAcP,SAASI,EAAUO,EAAKd,EAAU,CACjC,IAAIe,EACAC,EACAX,EACAY,EACAC,EACJ,GAAK,CAACjC,EAAsB6B,CAAI,EAC/B,MAAM,IAAI,UAAWlB,EAAQ,+EAAgFkB,CAAI,CAAE,EAGpH,GADAI,EAAI,CAAC,EACA,UAAU,OAAS,IACvBb,EAAMP,EAAUoB,EAAGlB,CAAQ,EACtBK,GACJ,MAAMA,EAIR,OADAY,EAAKC,EAAE,OAAShB,EAAK,MAChBe,IAAO,UACJxB,EAAUqB,EAAKV,CAAK,GAE5BW,EAAOvB,EAAOyB,CAAG,EACjBD,EAAM,IAAID,EAAMD,CAAI,EACpBpB,EAAS,CAAEsB,CAAI,EAAG,CAAEF,CAAI,EAAG,CAAE,CAAE,EAAGV,CAAK,EAChCY,EACR,CAgBA,SAASV,EAAUQ,EAAKK,EAAGC,EAAGpB,EAAU,CACvC,IAAIe,EACAC,EACAX,EACAY,EACAC,EACJ,GAAK,CAACjC,EAAsB6B,CAAI,EAC/B,MAAM,IAAI,UAAWlB,EAAQ,+EAAgFkB,CAAI,CAAE,EAGpH,GADAI,EAAI,CAAC,EACA,UAAU,OAAS,IACvBb,EAAMP,EAAUoB,EAAGlB,CAAQ,EACtBK,GACJ,MAAMA,EAKR,GADAY,EAAKC,EAAE,OAAShB,EAAK,MAChBe,IAAO,UACX,OAAOxB,EAAUqB,EAAKO,CAAQ,EAE/B,OAAAN,EAAOvB,EAAOyB,CAAG,EACjBD,EAAM,IAAID,EAAMD,CAAI,EACpBnB,EAAQ,CAAE,CAAEwB,CAAE,EAAG,CAAEC,CAAE,EAAGJ,CAAI,EAAG,CAAEF,CAAI,EAAG,CAAE,EAAG,EAAG,CAAE,EAAGV,CAAK,EACnDY,EAQP,SAASK,GAAU,CAClB,OAAOjB,EAAMe,EAAGC,CAAE,CACnB,CACD,CAQA,SAASZ,GAAU,CAClB,OAAOL,EAAK,KAAK,IAClB,CAQA,SAASM,GAAgB,CACxB,OAAON,EAAK,KAAK,UAClB,CAQA,SAASS,GAAiB,CACzB,OAAOT,EAAK,KAAK,WAClB,CAQA,SAASU,GAAe,CACvB,OAAOV,EAAK,KAAK,UAClB,CAQA,SAASO,GAAW,CACnB,OAAOP,EAAK,KAAK,KAClB,CASA,SAASQ,EAAUW,EAAI,CACtBnB,EAAK,KAAK,MAAQmB,CACnB,CACD,CAKAtC,EAAO,QAAUe,KCzRjB,IAAAwB,EAAAC,EAAA,SAAAC,GAAAC,EAAA,cAsBA,IAAIC,GAAU,IA8BVC,GAAUD,GAAQ,EAKtBD,EAAO,QAAUE,KCKjB,IAAIC,GAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,GAAU,IAKdF,GAAaC,EAAM,UAAWC,EAAQ,EAKtC,OAAO,QAAUD", - "names": ["require_defaults", "__commonJSMin", "exports", "module", "require_validate", "__commonJSMin", "exports", "module", "dtypes", "isObject", "hasOwnProp", "format", "DTYPES", "validate", "opts", "options", "require_factory", "__commonJSMin", "exports", "module", "isNonNegativeInteger", "setReadOnly", "setReadOnlyAccessor", "setReadWriteAccessor", "constantFunction", "noop", "base", "ctors", "filledBy", "nullary", "binary", "format", "defaults", "validate", "factory", "options", "nargs", "opts", "rand", "prng", "err", "uniform2", "uniform1", "getSeed", "getSeedLength", "getState", "setState", "getStateLength", "getStateSize", "len", "ctor", "out", "dt", "o", "a", "b", "wrapper", "s", "require_main", "__commonJSMin", "exports", "module", "factory", "uniform", "setReadOnly", "main", "factory"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 256216a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,169 +0,0 @@ - -{{alias}}( len, a, b[, options] ) - Returns an array containing pseudorandom numbers drawn from a continuous - uniform distribution. - - Parameters - ---------- - len: integer - Output array length. - - a: number - Minimum support. - - b: number - Maximum support. - - 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 ) - - - -{{alias}}.factory( [a, b, ][options] ) - Returns a function for creating arrays containing pseudorandom numbers drawn - from a continuous uniform distribution. - - If provided `a` and `b`, the returned function returns random variates drawn - from the specified distribution. - - If not provided `a` and `b`, the returned function requires that both `a` - and `b` 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. - - 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 ) - - - // Provide distribution parameters: - > fcn = {{alias}}.factory( 2.0, 5.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 ) - - - // Get a copy of the current state: - > var state = {{alias}}.state - - - > out = {{alias}}( 3, 2.0, 5.0 ) - - > out = {{alias}}( 3, 2.0, 5.0 ) - - - // Set the state: - > {{alias}}.state = state; - - // Regenerate a previous array: - > out = {{alias}}( 3, 2.0, 5.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 a087b98..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,355 +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. -*/ - -import random = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - random( 10, 2, 3 ); // $ExpectType RandomArray - random( 10, 1, 2 ); // $ExpectType RandomArray - random( 10, 1, 2, {} ); // $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 ); // $ExpectError - random( true, 2.0, 5.0 ); // $ExpectError - random( false, 2.0, 5.0 ); // $ExpectError - random( null, 2.0, 5.0 ); // $ExpectError - random( [], 2.0, 5.0 ); // $ExpectError - random( {}, 2.0, 5.0 ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - random( '5', 2.0, 5.0, {} ); // $ExpectError - random( true, 2.0, 5.0, {} ); // $ExpectError - random( false, 2.0, 5.0, {} ); // $ExpectError - random( null, 2.0, 5.0, {} ); // $ExpectError - random( [], 2.0, 5.0, {} ); // $ExpectError - random( {}, 2.0, 5.0, {} ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.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 ); // $ExpectError - random( 10, true, 5.0 ); // $ExpectError - random( 10, false, 5.0 ); // $ExpectError - random( 10, null, 5.0 ); // $ExpectError - random( 10, [], 5.0 ); // $ExpectError - random( 10, {}, 5.0 ); // $ExpectError - random( 10, ( x: number ): number => x, 5.0 ); // $ExpectError - - random( 10, '5', 5.0, {} ); // $ExpectError - random( 10, true, 5.0, {} ); // $ExpectError - random( 10, false, 5.0, {} ); // $ExpectError - random( 10, null, 5.0, {} ); // $ExpectError - random( 10, [], 5.0, {} ); // $ExpectError - random( 10, {}, 5.0, {} ); // $ExpectError - random( 10, ( x: number ): number => x, 5.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' ); // $ExpectError - random( 10, 2.0, true ); // $ExpectError - random( 10, 2.0, false ); // $ExpectError - random( 10, 2.0, null ); // $ExpectError - random( 10, 2.0, [] ); // $ExpectError - random( 10, 2.0, {} ); // $ExpectError - random( 10, 2.0, ( x: number ): number => x ); // $ExpectError - - random( 10, 2.0, '5', {} ); // $ExpectError - random( 10, 2.0, true, {} ); // $ExpectError - random( 10, 2.0, false, {} ); // $ExpectError - random( 10, 2.0, null, {} ); // $ExpectError - random( 10, 2.0, [], {} ); // $ExpectError - random( 10, 2.0, {}, {} ); // $ExpectError - random( 10, 2.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, '5' ); // $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, [] ); // $ExpectError - random( 10, 2.0, 5.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, { 'dtype': 123 } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': null } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - random( 10, 2.0, 5.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 -} - -// Attached to main export is a `factory` method which returns a function... -{ - random.factory( 2.0, 5.0 ); // $ExpectType UnaryFunction - random.factory( 2.0, 5.0, { 'copy': false } ); // $ExpectType UnaryFunction - - random.factory(); // $ExpectType TernaryFunction - random.factory( { 'copy': false } ); // $ExpectType TernaryFunction -} - -// The `factory` method returns a function which returns an array... -{ - const fcn1 = random.factory( 2.0, 5.0 ); - fcn1( 10 ); // $ExpectType RandomArray - - const fcn2 = random.factory(); - fcn2( 10, 2.0, 5.0 ); // $ExpectType RandomArray -} - -// The compiler throws an error if the `factory` method is provided invalid arguments... -{ - random.factory( '5', 5.0 ); // $ExpectError - random.factory( true, 5.0 ); // $ExpectError - random.factory( false, 5.0 ); // $ExpectError - random.factory( [], 5.0 ); // $ExpectError - random.factory( {}, 5.0 ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0 ); // $ExpectError - - random.factory( '5', 5.0, {} ); // $ExpectError - random.factory( true, 5.0, {} ); // $ExpectError - random.factory( false, 5.0, {} ); // $ExpectError - random.factory( [], 5.0, {} ); // $ExpectError - random.factory( {}, 5.0, {} ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0, {} ); // $ExpectError - - random.factory( 2.0, '5' ); // $ExpectError - random.factory( 2.0, true ); // $ExpectError - random.factory( 2.0, false ); // $ExpectError - random.factory( 2.0, [] ); // $ExpectError - random.factory( 2.0, {} ); // $ExpectError - random.factory( 2.0, ( x: number ): number => x ); // $ExpectError - - random.factory( 2.0, '5', {} ); // $ExpectError - random.factory( 2.0, true, {} ); // $ExpectError - random.factory( 2.0, false, {} ); // $ExpectError - random.factory( 2.0, [], {} ); // $ExpectError - random.factory( 2.0, {}, {} ); // $ExpectError - random.factory( 2.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, 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, { 'prng': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'seed': true } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': [ 'a' ] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'state': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': {} } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': true ); // $ExpectError - random.factory( 2.0, 5.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, { 'copy': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'dtype': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - random.factory( 2.0, 5.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, {}, {} ); // $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 ); - 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 ); // $ExpectError - fcn2( false, 2.0, 5.0 ); // $ExpectError - fcn2( '5', 2.0, 5.0 ); // $ExpectError - fcn2( [], 2.0, 5.0 ); // $ExpectError - fcn2( {}, 2.0, 5.0 ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - fcn2( true, 2.0, 5.0, {} ); // $ExpectError - fcn2( false, 2.0, 5.0, {} ); // $ExpectError - fcn2( '5', 2.0, 5.0, {} ); // $ExpectError - fcn2( [], 2.0, 5.0, {} ); // $ExpectError - fcn2( {}, 2.0, 5.0, {} ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0, {} ); // $ExpectError - - fcn2( 10, true, 5.0 ); // $ExpectError - fcn2( 10, false, 5.0 ); // $ExpectError - fcn2( 10, '5', 5.0 ); // $ExpectError - fcn2( 10, [], 5.0 ); // $ExpectError - fcn2( 10, {}, 5.0 ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0 ); // $ExpectError - - fcn2( 10, true, 5.0, {} ); // $ExpectError - fcn2( 10, false, 5.0, {} ); // $ExpectError - fcn2( 10, '5', 5.0, {} ); // $ExpectError - fcn2( 10, [], 5.0, {} ); // $ExpectError - fcn2( 10, {}, 5.0, {} ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0, {} ); // $ExpectError - - fcn2( 10, 2.0, true ); // $ExpectError - fcn2( 10, 2.0, false ); // $ExpectError - fcn2( 10, 2.0, '5' ); // $ExpectError - fcn2( 10, 2.0, [] ); // $ExpectError - fcn2( 10, 2.0, {} ); // $ExpectError - fcn2( 10, 2.0, ( x: number ): number => x ); // $ExpectError - - fcn2( 10, 2.0, true, {} ); // $ExpectError - fcn2( 10, 2.0, false, {} ); // $ExpectError - fcn2( 10, 2.0, '5', {} ); // $ExpectError - fcn2( 10, 2.0, [], {} ); // $ExpectError - fcn2( 10, 2.0, {}, {} ); // $ExpectError - fcn2( 10, 2.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, { 'dtype': 123 } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': null } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError - - const fcn2 = random.factory( 2.0, 5.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 ); - fcn1(); // $ExpectError - fcn1( 1, 1, 1 ); // $ExpectError - - const fcn2 = random.factory(); - fcn2(); // $ExpectError - fcn2( 1 ); // $ExpectError - fcn2( 1, 1, 1, 1 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index c485546..0000000 --- a/examples/index.js +++ /dev/null @@ -1,48 +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'; - -var logEach = require( '@stdlib/console-log-each' ); -var uniform = require( './../lib' ); - -// Create a function for generating random arrays originating from the same state: -var random = uniform.factory( 2.0, 5.0, { - 'state': uniform.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 = uniform.factory( 2.0, 5.0, { - 'state': uniform.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 6fef7d9..e49ce72 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { FloatDataType, 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..e387923 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.1.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-accessor@esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-write-accessor@v0.1.0-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-constant-function@v0.1.0-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-noop@v0.1.0-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/random-base-uniform@esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-typed-real-float-ctors@v0.1.0-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@v0.1.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-nullary@v0.1.0-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@v0.1.0-esm/index.mjs";import f from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.1.0-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/array-typed-real-float-dtypes@v0.1.0-esm/index.mjs";import h from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.1.0-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.1.0-esm/index.mjs";var c="float64",u=a();function g(e,t){return h(t)?j(t,"dtype")&&(e.dtype=t.dtype,u.indexOf(e.dtype)<0)?new TypeError(f("1eR2X,3g,4S,GD,Gg,Jm","dtype",u.join('", "'),e.dtype)):null:new TypeError(f("1eR2V,FD",t))}function y(){var a,h,j,u,y,v;if(j={dtype:c},0===(h=arguments.length))y=d,u=x;else if(1===h){if(a=arguments[0],y=d.factory(a),v=g(j,a))throw v;u=x}else if(2===h)y=d.factory(arguments[0],arguments[1]),u=b;else if(3===h){if(a=arguments[2],y=d.factory(arguments[0],arguments[1],a),v=g(j,a))throw v;u=b}return a&&a.prng?(e(u,"seed",null),e(u,"seedLength",null),n(u,"state",r(null),i),e(u,"stateLength",null),e(u,"byteLength",null)):(s(u,"seed",w),s(u,"seedLength",G),n(u,"state",N,P),s(u,"stateLength",R),s(u,"byteLength",L)),e(u,"PRNG",y.PRNG),u;function b(e,s){var n,r,i,d;if(!t(e))throw new TypeError(f("1eR2d,MG",e));if(d={},arguments.length>1&&(r=g(d,s)))throw r;return"generic"===(i=d.dtype||j.dtype)?l(e,y):(n=new(o(i))(e),m([n],[e],[1],y),n)}function x(e,s,n,r){var i,d,m,a;if(!t(e))throw new TypeError(f("1eR2d,MG",e));if(a={},arguments.length>3&&(d=g(a,r)))throw d;return"generic"===(m=a.dtype||j.dtype)?l(e,h):(i=new(o(m))(e),p([[s],[n],i],[e],[0,0,1],y),i);function h(){return y(s,n)}}function w(){return u.PRNG.seed}function G(){return u.PRNG.seedLength}function R(){return u.PRNG.stateLength}function L(){return u.PRNG.byteLength}function N(){return u.PRNG.state}function P(e){u.PRNG.state=e}}u.push("generic");var v=y();e(v,"factory",y);export{v as default,y as factory}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..debf665 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/factory.js","../lib/main.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 dtypes from '@stdlib/array-typed-real-float-dtypes';\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes();\nDTYPES.push( 'generic' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '1eR2V,FD', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( DTYPES.indexOf( opts.dtype ) < 0 ) {\n\t\t\treturn new TypeError( format( '1eR2X,3g,4S,GD,Gg,Jm', 'dtype', DTYPES.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport setReadOnlyAccessor from '@stdlib/utils-define-nonenumerable-read-only-accessor';\nimport setReadWriteAccessor from '@stdlib/utils-define-nonenumerable-read-write-accessor';\nimport constantFunction from '@stdlib/utils-constant-function';\nimport noop from '@stdlib/utils-noop';\nimport base from '@stdlib/random-base-uniform';\nimport ctors from '@stdlib/array-typed-real-float-ctors';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport nullary from '@stdlib/strided-base-nullary';\nimport binary from '@stdlib/strided-base-binary';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution.\n*\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\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 {RangeError} `a` must be less than `b`\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 uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10 );\n* // returns \n*\n* @example\n* var uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nfunction factory() {\n\tvar options;\n\tvar nargs;\n\tvar opts;\n\tvar rand;\n\tvar prng;\n\tvar err;\n\n\topts = {\n\t\t'dtype': defaults.dtype\n\t};\n\n\tnargs = arguments.length;\n\tif ( nargs === 0 ) {\n\t\tprng = base;\n\t\trand = uniform2;\n\t} else if ( nargs === 1 ) {\n\t\toptions = arguments[ 0 ];\n\t\tprng = base.factory( options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform2;\n\t} else if ( nargs === 2 ) {\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ] );\n\t\trand = uniform1;\n\t} else if ( nargs === 3 ) {\n\t\toptions = arguments[ 2 ];\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ], options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform1;\n\t}\n\tif ( options && options.prng ) {\n\t\tsetReadOnly( rand, 'seed', null );\n\t\tsetReadOnly( rand, 'seedLength', null );\n\t\tsetReadWriteAccessor( rand, 'state', constantFunction( null ), noop );\n\t\tsetReadOnly( rand, 'stateLength', null );\n\t\tsetReadOnly( rand, 'byteLength', null );\n\t} else {\n\t\tsetReadOnlyAccessor( rand, 'seed', getSeed );\n\t\tsetReadOnlyAccessor( rand, 'seedLength', getSeedLength );\n\t\tsetReadWriteAccessor( rand, 'state', getState, setState );\n\t\tsetReadOnlyAccessor( rand, 'stateLength', getStateLength );\n\t\tsetReadOnlyAccessor( rand, 'byteLength', getStateSize );\n\t}\n\tsetReadOnly( rand, 'PRNG', prng.PRNG );\n\treturn rand;\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform1( len, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( '1eR2d,MG', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 1 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, prng );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tnullary( [ out ], [ len ], [ 1 ], prng );\n\t\treturn out;\n\t}\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {number} a - minimum support\n\t* @param {number} b - maximum support\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform2( len, a, b, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( '1eR2d,MG', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 3 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\t// NOTE: we could alternatively use the PRNG factory function to create a PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. Decision made here to avoid this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom number. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in a return value of `NaN`.\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, wrapper );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tbinary( [ [ a ], [ b ], out ], [ len ], [ 0, 0, 1 ], prng );\n\t\treturn out;\n\n\t\t/**\n\t\t* Applies parameters to a pseudorandom number generator function.\n\t\t*\n\t\t* @private\n\t\t* @returns {number} pseudorandom number\n\t\t*/\n\t\tfunction wrapper() {\n\t\t\treturn prng( a, b );\n\t\t}\n\t}\n\n\t/**\n\t* Returns the PRNG seed.\n\t*\n\t* @private\n\t* @returns {PRNGSeedMT19937} seed\n\t*/\n\tfunction getSeed() {\n\t\treturn rand.PRNG.seed;\n\t}\n\n\t/**\n\t* Returns the PRNG seed length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} seed length\n\t*/\n\tfunction getSeedLength() {\n\t\treturn rand.PRNG.seedLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state length\n\t*/\n\tfunction getStateLength() {\n\t\treturn rand.PRNG.stateLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state size (in bytes).\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state size (in bytes)\n\t*/\n\tfunction getStateSize() {\n\t\treturn rand.PRNG.byteLength;\n\t}\n\n\t/**\n\t* Returns the current pseudorandom number generator state.\n\t*\n\t* @private\n\t* @returns {PRNGStateMT19937} current state\n\t*/\n\tfunction getState() {\n\t\treturn rand.PRNG.state;\n\t}\n\n\t/**\n\t* Sets the pseudorandom number generator state.\n\t*\n\t* @private\n\t* @param {PRNGStateMT19937} s - generator state\n\t* @throws {Error} must provide a valid state\n\t*/\n\tfunction setState( s ) {\n\t\trand.PRNG.state = s;\n\t}\n}\n\n\n// EXPORTS //\n\nexport default factory;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @name uniform\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\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 = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar uniform = factory();\n\n\n// EXPORTS //\n\nexport default uniform;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @module @stdlib/random-array-uniform\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.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\" }\n"],"names":["DTYPES","dtypes","validate","opts","options","isObject","hasOwnProp","dtype","indexOf","TypeError","format","join","factory","nargs","rand","prng","err","defaults","arguments","length","base","uniform2","uniform1","setReadOnly","setReadWriteAccessor","constantFunction","noop","setReadOnlyAccessor","getSeed","getSeedLength","getState","setState","getStateLength","getStateSize","PRNG","len","out","dt","o","isNonNegativeInteger","filledBy","ctors","nullary","a","b","wrapper","binary","seed","seedLength","stateLength","byteLength","state","s","push","uniform","main"],"mappings":";;+/CA8BIA,EAASC,IAyBb,SAASC,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,WACzBD,EAAKI,MAAQH,EAAQG,MAChBP,EAAOQ,QAASL,EAAKI,OAAU,GAC5B,IAAIE,UAAWC,EAAQ,uBAAwB,QAASV,EAAOW,KAAM,QAAUR,EAAKI,QAGtF,KARC,IAAIE,UAAWC,EAAQ,WAAYN,GAS5C,CCSA,SAASQ,IACR,IAAIR,EACAS,EACAV,EACAW,EACAC,EACAC,EAOJ,GALAb,EAAO,CACNI,MAASU,GAIK,KADfJ,EAAQK,UAAUC,QAEjBJ,EAAOK,EACPN,EAAOO,OACD,GAAe,IAAVR,EAAc,CAIzB,GAHAT,EAAUc,UAAW,GACrBH,EAAOK,EAAKR,QAASR,GACrBY,EAAMd,EAAUC,EAAMC,GAErB,MAAMY,EAEPF,EAAOO,CACT,MAAQ,GAAe,IAAVR,EACXE,EAAOK,EAAKR,QAASM,UAAW,GAAKA,UAAW,IAChDJ,EAAOQ,OACD,GAAe,IAAVT,EAAc,CAIzB,GAHAT,EAAUc,UAAW,GACrBH,EAAOK,EAAKR,QAASM,UAAW,GAAKA,UAAW,GAAKd,GACrDY,EAAMd,EAAUC,EAAMC,GAErB,MAAMY,EAEPF,EAAOQ,CACP,CAeD,OAdKlB,GAAWA,EAAQW,MACvBQ,EAAaT,EAAM,OAAQ,MAC3BS,EAAaT,EAAM,aAAc,MACjCU,EAAsBV,EAAM,QAASW,EAAkB,MAAQC,GAC/DH,EAAaT,EAAM,cAAe,MAClCS,EAAaT,EAAM,aAAc,QAEjCa,EAAqBb,EAAM,OAAQc,GACnCD,EAAqBb,EAAM,aAAce,GACzCL,EAAsBV,EAAM,QAASgB,EAAUC,GAC/CJ,EAAqBb,EAAM,cAAekB,GAC1CL,EAAqBb,EAAM,aAAcmB,IAE1CV,EAAaT,EAAM,OAAQC,EAAKmB,MACzBpB,EAcP,SAASQ,EAAUa,EAAK/B,GACvB,IACIgC,EACApB,EACAqB,EACAC,EACJ,IAAMC,EAAsBJ,GAC3B,MAAM,IAAI1B,UAAWC,EAAQ,WAAYyB,IAG1C,GADAG,EAAI,CAAA,EACCpB,UAAUC,OAAS,IACvBH,EAAMd,EAAUoC,EAAGlC,IAElB,MAAMY,EAIR,MAAY,aADZqB,EAAKC,EAAE/B,OAASJ,EAAKI,OAEbiC,EAAUL,EAAKpB,IAGvBqB,EAAM,IADCK,EAAOJ,GACR,CAAUF,GAChBO,EAAS,CAAEN,GAAO,CAAED,GAAO,CAAE,GAAKpB,GAC3BqB,EACP,CAgBD,SAASf,EAAUc,EAAKQ,EAAGC,EAAGxC,GAC7B,IACIgC,EACApB,EACAqB,EACAC,EACJ,IAAMC,EAAsBJ,GAC3B,MAAM,IAAI1B,UAAWC,EAAQ,WAAYyB,IAG1C,GADAG,EAAI,CAAA,EACCpB,UAAUC,OAAS,IACvBH,EAAMd,EAAUoC,EAAGlC,IAElB,MAAMY,EAKR,MAAY,aADZqB,EAAKC,EAAE/B,OAASJ,EAAKI,OAEbiC,EAAUL,EAAKU,IAGvBT,EAAM,IADCK,EAAOJ,GACR,CAAUF,GAChBW,EAAQ,CAAE,CAAEH,GAAK,CAAEC,GAAKR,GAAO,CAAED,GAAO,CAAE,EAAG,EAAG,GAAKpB,GAC9CqB,GAQP,SAASS,IACR,OAAO9B,EAAM4B,EAAGC,EAChB,CACD,CAQD,SAAShB,IACR,OAAOd,EAAKoB,KAAKa,IACjB,CAQD,SAASlB,IACR,OAAOf,EAAKoB,KAAKc,UACjB,CAQD,SAAShB,IACR,OAAOlB,EAAKoB,KAAKe,WACjB,CAQD,SAAShB,IACR,OAAOnB,EAAKoB,KAAKgB,UACjB,CAQD,SAASpB,IACR,OAAOhB,EAAKoB,KAAKiB,KACjB,CASD,SAASpB,EAAUqB,GAClBtC,EAAKoB,KAAKiB,MAAQC,CAClB,CACF,CDrPApD,EAAOqD,KAAM,WEqBV,IAACC,EAAU1C,ICiBdW,EAAAgC,EAAA,UAAA3C"} \ No newline at end of file diff --git a/lib/defaults.json b/lib/defaults.json deleted file mode 100644 index 83f4438..0000000 --- a/lib/defaults.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "dtype": "float64" -} diff --git a/lib/factory.js b/lib/factory.js deleted file mode 100644 index 24d5d10..0000000 --- a/lib/factory.js +++ /dev/null @@ -1,282 +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 isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var setReadOnlyAccessor = require( '@stdlib/utils-define-nonenumerable-read-only-accessor' ); -var setReadWriteAccessor = require( '@stdlib/utils-define-nonenumerable-read-write-accessor' ); -var constantFunction = require( '@stdlib/utils-constant-function' ); -var noop = require( '@stdlib/utils-noop' ); -var base = require( '@stdlib/random-base-uniform' ); -var ctors = require( '@stdlib/array-typed-real-float-ctors' ); -var filledBy = require( '@stdlib/array-base-filled-by' ); -var nullary = require( '@stdlib/strided-base-nullary' ); -var binary = require( '@stdlib/strided-base-binary' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution. -* -* @param {number} [a] - minimum support -* @param {number} [b] - maximum support -* @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 {RangeError} `a` must be less than `b` -* @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 uniform = factory( 2.0, 5.0 ); -* // returns -* -* var arr = uniform( 10 ); -* // returns -* -* @example -* var uniform = factory( 2.0, 5.0 ); -* // returns -* -* var arr = uniform( 10, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -function factory() { - var options; - var nargs; - var opts; - var rand; - var prng; - var err; - - opts = { - 'dtype': defaults.dtype - }; - - nargs = arguments.length; - if ( nargs === 0 ) { - prng = base; - rand = uniform2; - } else if ( nargs === 1 ) { - options = arguments[ 0 ]; - prng = base.factory( options ); - err = validate( opts, options ); - if ( err ) { - throw err; - } - rand = uniform2; - } else if ( nargs === 2 ) { - prng = base.factory( arguments[ 0 ], arguments[ 1 ] ); - rand = uniform1; - } else if ( nargs === 3 ) { - options = arguments[ 2 ]; - prng = base.factory( arguments[ 0 ], arguments[ 1 ], options ); - err = validate( opts, options ); - if ( err ) { - throw err; - } - rand = uniform1; - } - if ( options && options.prng ) { - setReadOnly( rand, 'seed', null ); - setReadOnly( rand, 'seedLength', null ); - setReadWriteAccessor( rand, 'state', constantFunction( null ), noop ); - setReadOnly( rand, 'stateLength', null ); - setReadOnly( rand, 'byteLength', null ); - } else { - setReadOnlyAccessor( rand, 'seed', getSeed ); - setReadOnlyAccessor( rand, 'seedLength', getSeedLength ); - setReadWriteAccessor( rand, 'state', getState, setState ); - setReadOnlyAccessor( rand, 'stateLength', getStateLength ); - setReadOnlyAccessor( rand, 'byteLength', getStateSize ); - } - setReadOnly( rand, 'PRNG', prng.PRNG ); - return rand; - - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @private - * @param {NonNegativeInteger} len - array length - * @param {Options} [options] - function options - * @param {string} [options.dtype] - 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 - */ - function uniform1( len, options ) { - var ctor; - var out; - var err; - var dt; - var o; - if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( '1eR2d,MG', len ) ); - } - o = {}; - if ( arguments.length > 1 ) { - err = validate( o, options ); - if ( err ) { - throw err; - } - } - dt = o.dtype || opts.dtype; - if ( dt === 'generic' ) { - return filledBy( len, prng ); - } - ctor = ctors( dt ); - out = new ctor( len ); - nullary( [ out ], [ len ], [ 1 ], prng ); - return out; - } - - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @private - * @param {NonNegativeInteger} len - array length - * @param {number} a - minimum support - * @param {number} b - maximum support - * @param {Options} [options] - function options - * @param {string} [options.dtype] - 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 - */ - function uniform2( len, a, b, options ) { - var ctor; - var out; - var err; - var dt; - var o; - if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( '1eR2d,MG', len ) ); - } - o = {}; - if ( arguments.length > 3 ) { - err = validate( o, options ); - if ( err ) { - throw err; - } - } - // NOTE: we could alternatively use the PRNG factory function to create a PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. Decision made here to avoid this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom number. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in a return value of `NaN`. - dt = o.dtype || opts.dtype; - if ( dt === 'generic' ) { - return filledBy( len, wrapper ); - } - ctor = ctors( dt ); - out = new ctor( len ); - binary( [ [ a ], [ b ], out ], [ len ], [ 0, 0, 1 ], prng ); - return out; - - /** - * Applies parameters to a pseudorandom number generator function. - * - * @private - * @returns {number} pseudorandom number - */ - function wrapper() { - return prng( a, b ); - } - } - - /** - * Returns the PRNG seed. - * - * @private - * @returns {PRNGSeedMT19937} seed - */ - function getSeed() { - return rand.PRNG.seed; - } - - /** - * Returns the PRNG seed length. - * - * @private - * @returns {PositiveInteger} seed length - */ - function getSeedLength() { - return rand.PRNG.seedLength; - } - - /** - * Returns the PRNG state length. - * - * @private - * @returns {PositiveInteger} state length - */ - function getStateLength() { - return rand.PRNG.stateLength; - } - - /** - * Returns the PRNG state size (in bytes). - * - * @private - * @returns {PositiveInteger} state size (in bytes) - */ - function getStateSize() { - return rand.PRNG.byteLength; - } - - /** - * Returns the current pseudorandom number generator state. - * - * @private - * @returns {PRNGStateMT19937} current state - */ - function getState() { - return rand.PRNG.state; - } - - /** - * Sets the pseudorandom number generator state. - * - * @private - * @param {PRNGStateMT19937} s - generator state - * @throws {Error} must provide a valid state - */ - function setState( s ) { - rand.PRNG.state = s; - } -} - - -// EXPORTS // - -module.exports = factory; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 0077f00..0000000 --- a/lib/index.js +++ /dev/null @@ -1,77 +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'; - -/** -* Create an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. -* -* @module @stdlib/random-array-uniform -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var arr = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var arr = uniform( 10, 2.0, 5.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var rand = uniform.factory( 2.0, 5.0 ); -* // returns -* -* var arr = rand( 10 ); -* // returns -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var rand = uniform.factory( 2.0, 5.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" } diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index da0d9b1..0000000 --- a/lib/main.js +++ /dev/null @@ -1,58 +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 factory = require( './factory.js' ); - - -// MAIN // - -/** -* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. -* -* @name uniform -* @type {Function} -* @param {NonNegativeInteger} len - array length -* @param {number} a - minimum support -* @param {number} b - maximum support -* @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 = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var arr = uniform( 10, 2.0, 5.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -var uniform = factory(); - - -// EXPORTS // - -module.exports = uniform; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index 1c3d511..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,72 +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 dtypes = require( '@stdlib/array-typed-real-float-dtypes' ); -var isObject = require( '@stdlib/assert-is-plain-object' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// VARIABLES // - -var DTYPES = dtypes(); -DTYPES.push( 'generic' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Options} options - function options -* @param {string} [options.dtype] - output array data type -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var options = { -* 'dtype': 'float64' -* }; -* var err = validate( opts, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( '1eR2V,FD', options ) ); - } - if ( hasOwnProp( options, 'dtype' ) ) { - opts.dtype = options.dtype; - if ( DTYPES.indexOf( opts.dtype ) < 0 ) { - return new TypeError( format( '1eR2X,3g,4S,GD,Gg,Jm', 'dtype', DTYPES.join( '", "' ), opts.dtype ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index 0c95623..767a213 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 continuous uniform 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,55 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-filled-by": "^0.1.0", - "@stdlib/array-typed-real-float-ctors": "^0.1.0", - "@stdlib/array-typed-real-float-dtypes": "^0.1.0", - "@stdlib/assert-has-own-property": "^0.1.0", - "@stdlib/assert-is-nonnegative-integer": "^0.1.0", - "@stdlib/assert-is-plain-object": "^0.1.0", - "@stdlib/random-base-uniform": "^0.1.0", - "@stdlib/strided-base-binary": "^0.1.0", - "@stdlib/strided-base-nullary": "^0.1.0", - "@stdlib/error-tools-fmtprodmsg": "^0.1.0", - "@stdlib/types": "^0.1.0", - "@stdlib/utils-constant-function": "^0.1.0", - "@stdlib/utils-define-nonenumerable-read-only-accessor": "^0.1.0", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.0", - "@stdlib/utils-define-nonenumerable-read-write-accessor": "^0.1.0", - "@stdlib/utils-noop": "^0.1.0" - }, - "devDependencies": { - "@stdlib/array-float32": "^0.1.0", - "@stdlib/array-float64": "^0.1.0", - "@stdlib/array-uint32": "^0.1.0", - "@stdlib/assert-is-uint32array": "^0.1.0", - "@stdlib/bench": "^0.1.0", - "@stdlib/console-log-each": "^0.1.0", - "@stdlib/constants-uint32-max": "^0.1.0", - "@stdlib/math-base-assert-is-nan": "^0.1.0", - "@stdlib/math-base-assert-is-nanf": "^0.1.0", - "@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" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdmath", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..3ae4e42 --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/test.factory.js b/test/test.factory.js deleted file mode 100644 index a869e75..0000000 --- a/test/test.factory.js +++ /dev/null @@ -1,1328 +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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -tape( 'the function throws an error if the second distribution parameter is less than the first distribution parameter', function test( t ) { - var values; - var i; - - values = [ - [ 0.0, 0.0 ], - [ -2.0, -4.0 ], - [ 2.0, 1.0 ] - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( arr ) { - return function badValue() { - factory( arr[0], arr[1] ); - }; - } -}); - -tape( 'the function throws an error if the second distribution parameter is less than the first distribution parameter (options)', function test( t ) { - var values; - var i; - - values = [ - [ 0.0, 0.0 ], - [ -2.0, -4.0 ], - [ 2.0, 1.0 ] - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( arr ) { - return function badValue() { - factory( arr[0], arr[1], {} ); - }; - } -}); - -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, 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, { - '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, { - '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, { - '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, { - '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, { - '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, { - '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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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 ); - - 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 ); - - 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, { - '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 ); - - 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 ); - 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( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory(); - actual = random( 10, 2.0, 5.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( typeof actual[ i ], 'number', '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 ); - - 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 ); - - 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 ); - - 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 that generates `NaN` values if the first distribution parameter is greater than or equal to the second distribution parameter', function test( t ) { - var random; - var values; - var actual; - var i; - var j; - - random = factory(); - values = [ - [ 2.0, 1.0 ], - [ -3.0, -4.0 ], - [ 0.0, 0.0 ] - ]; - - for ( i = 0; i < values.length; i++ ) { - actual = random( 10, values[ i ][ 0 ], values[ i ][ 1 ] ); - for ( j = 0; j < actual.length; j++ ) { - t.strictEqual( isnan( actual[ j ] ), true, 'returns expected value when provided '+values[ 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, { - '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 ); - - 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, { - '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( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'float64' - }); - actual = random( 10, 2.0, 5.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( typeof actual[ i ], 'number', '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, { - '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( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'float32' - }); - actual = random( 10, 2.0, 5.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( typeof actual[ i ], 'number', '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, { - '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 ); - - 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, { - '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, { - '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 ); - - // 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, { - '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 ); - - // 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, { - '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 ); - - 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, { - 'prng': randu.normalized - }); - - randu = minstd.factory({ - 'seed': seed - }); - random2 = factory( 2.0, 5.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 ); - arr2 = random2( 10, 2.0, 5.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 c4fb6d3..0000000 --- a/test/test.js +++ /dev/null @@ -1,69 +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 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 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 37b0080..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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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, 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, { - '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 ); - - 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( typeof actual[ i ], 'number', '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, { - '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( typeof actual[ i ], 'number', '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, { - '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( typeof actual[ i ], 'number', '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, { - '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 ); - } - // Capture the current state: - state = random.state; - - // Move to a future state... - arr = random( 10, 2.0, 5.0 ); - for ( i = 0; i < 100; i++ ) { - random( 2, 2.0, 5.0 ); - } - // Set the state: - random.state = state; - - // Replay previously generated values: - t.deepEqual( random( 10, 2.0, 5.0 ), arr, 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.validate.js b/test/test.validate.js deleted file mode 100644 index 9fbe15f..0000000 --- a/test/test.validate.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 validate = require( './../lib/validate.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof validate, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function returns an error if provided an options argument which is not an object', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - void 0, - null, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, values[ i ] ); - t.equal( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided a `dtype` option which is not a supported data type', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - -5, - NaN, - true, - false, - void 0, - null, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, { - 'dtype': values[ i ] - }); - t.equal( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns null if all options are valid', function test( t ) { - var options; - var opts; - var err; - - options = { - 'dtype': 'float64' - }; - opts = {}; - err = validate( opts, options ); - - t.equal( err, null, 'returns null' ); - t.deepEqual( opts, options, 'sets option values' ); - - t.end(); -}); - -tape( 'the function ignores unrecognized/unsupported options', function test( t ) { - var options; - var opts; - var err; - - options = { - 'beep': true, - 'boop': 'bop' - }; - opts = {}; - err = validate( opts, options ); - - t.equal( err, null, 'returns null' ); - t.deepEqual( opts, {}, 'does not set any option values' ); - t.end(); -}); From 48c74f57be2e658b435e86bad991557c6cafe3b0 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 24 Sep 2023 22:32:14 +0000 Subject: [PATCH 29/82] 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 2e70ba7..0f1a0b3 100644 --- a/README.md +++ b/README.md @@ -42,13 +42,13 @@ limitations under the License. ## Usage ```javascript -import uniform from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-uniform@esm/index.mjs'; +import uniform from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-uniform@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-uniform@esm/index.mjs'; +import { factory } from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-uniform@v0.1.0-esm/index.mjs'; ``` #### uniform( len, a, b\[, options] ) @@ -320,7 +320,7 @@ var sz = random.byteLength; - - - - From 1f580653b66b885a821dab8c82998ba002a3db2e Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 3 Oct 2023 04:55:19 +0000 Subject: [PATCH 33/82] Auto-generated commit --- .editorconfig | 186 - .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 | 247 - .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 | 227 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 61 +- benchmark/benchmark.float32.factory.js | 96 - benchmark/benchmark.float32.js | 98 - benchmark/benchmark.float64.factory.js | 96 - benchmark/benchmark.float64.js | 98 - benchmark/benchmark.generic.factory.js | 96 - benchmark/benchmark.generic.js | 98 - branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 9 - dist/index.js.map | 7 - docs/repl.txt | 169 - docs/types/test.ts | 355 -- examples/index.js | 48 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/defaults.json | 3 - lib/factory.js | 282 - lib/index.js | 77 - lib/main.js | 58 - lib/validate.js | 72 - package.json | 76 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 69 - test/test.factory.js | 1328 ----- test/test.js | 69 - test/test.main.js | 244 - test/test.validate.js | 118 - 53 files changed, 6215 insertions(+), 6812 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 benchmark/benchmark.float32.factory.js delete mode 100644 benchmark/benchmark.float32.js delete mode 100644 benchmark/benchmark.float64.factory.js delete mode 100644 benchmark/benchmark.float64.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/defaults.json delete mode 100644 lib/factory.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.factory.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js delete mode 100644 test/test.validate.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 13e9c39..0000000 --- a/.editorconfig +++ /dev/null @@ -1,186 +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 `tslint.json` files: -[tslint.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 1d3b89d..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2023-10-01T06:02:16.834Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index c4ab52b..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/uniform) 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 ab56cca..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 corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # 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: 16 - 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 5097056..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/uniform) 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 c1c45e7..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 corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # 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: 16 - 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 bd8d245..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: '33 9 * * 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 corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - 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: 16 - 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 corresponding to v3.0.3: - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 - 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 265afda..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 corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - 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: 16 - 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 corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - 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: 16 - 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 corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # 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: 16 - 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 corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # 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: 16 - 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 + + ```
@@ -375,7 +374,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]. @@ -435,13 +434,13 @@ Copyright © 2016-2023. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/random-array-uniform/main/LICENSE -[@stdlib/random/base/uniform]: https://github.com/stdlib-js/random-base-uniform +[@stdlib/random/base/uniform]: https://github.com/stdlib-js/random-base-uniform/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/benchmark/benchmark.float32.factory.js b/benchmark/benchmark.float32.factory.js deleted file mode 100644 index 67e61f4..0000000 --- a/benchmark/benchmark.float32.factory.js +++ /dev/null @@ -1,96 +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 bench = require( '@stdlib/bench' ); -var isnanf = require( '@stdlib/math-base-assert-is-nanf' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var fcn = uniform.factory( 2.0, 5.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 4642816..0000000 --- a/benchmark/benchmark.float32.js +++ /dev/null @@ -1,98 +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 bench = require( '@stdlib/bench' ); -var isnanf = require( '@stdlib/math-base-assert-is-nanf' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = 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 = uniform( len, 2.0, 5.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.factory.js b/benchmark/benchmark.float64.factory.js deleted file mode 100644 index 8646a54..0000000 --- a/benchmark/benchmark.float64.factory.js +++ /dev/null @@ -1,96 +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 bench = require( '@stdlib/bench' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var fcn = uniform.factory( 2.0, 5.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 5ee0d97..0000000 --- a/benchmark/benchmark.float64.js +++ /dev/null @@ -1,98 +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 bench = require( '@stdlib/bench' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = 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 = uniform( len, 2.0, 5.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.factory.js b/benchmark/benchmark.generic.factory.js deleted file mode 100644 index 7020d62..0000000 --- a/benchmark/benchmark.generic.factory.js +++ /dev/null @@ -1,96 +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 bench = require( '@stdlib/bench' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var fcn = uniform.factory( 2.0, 5.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 06a2a83..0000000 --- a/benchmark/benchmark.generic.js +++ /dev/null @@ -1,98 +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 bench = require( '@stdlib/bench' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = 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 = uniform( len, 2.0, 5.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 30542fb..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/uniform" -%% click B href "https://github.com/stdlib-js/random-array-uniform/tree/main" -%% click C href "https://github.com/stdlib-js/random-array-uniform/tree/production" -%% click D href "https://github.com/stdlib-js/random-array-uniform/tree/esm" -%% click E href "https://github.com/stdlib-js/random-array-uniform/tree/deno" -%% click F href "https://github.com/stdlib-js/random-array-uniform/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/uniform -[production-url]: https://github.com/stdlib-js/random-array-uniform/tree/production -[deno-url]: https://github.com/stdlib-js/random-array-uniform/tree/deno -[umd-url]: https://github.com/stdlib-js/random-array-uniform/tree/umd -[esm-url]: https://github.com/stdlib-js/random-array-uniform/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 f2a679f..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import uniform from '../docs/types/index'; -export = uniform; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 0ef1443..0000000 --- a/dist/index.js +++ /dev/null @@ -1,9 +0,0 @@ -"use strict";var y=function(t,r){return function(){return r||t((r={exports:{}}).exports,r),r.exports}};var b=y(function(ue,H){H.exports={dtype:"float64"}});var O=y(function(se,G){ -var J=require('@stdlib/array-typed-real-float-dtypes/dist'),K=require('@stdlib/assert-is-plain-object/dist'),M=require('@stdlib/assert-has-own-property/dist'),N=require('@stdlib/error-tools-fmtprodmsg/dist'),w=J();w.push("generic");function Q(t,r){return K(r)?M(r,"dtype")&&(t.dtype=r.dtype,w.indexOf(t.dtype)<0)?new TypeError(N('1eR4S',"dtype",w.join('", "'),t.dtype)):null:new TypeError(N('1eR2V',r));}G.exports=Q -});var R=y(function(oe,F){ -var S=require('@stdlib/assert-is-nonnegative-integer/dist').isPrimitive,d=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),l=require('@stdlib/utils-define-nonenumerable-read-only-accessor/dist'),x=require('@stdlib/utils-define-nonenumerable-read-write-accessor/dist'),U=require('@stdlib/utils-constant-function/dist'),X=require('@stdlib/utils-noop/dist'),p=require('@stdlib/random-base-uniform/dist'),E=require('@stdlib/array-typed-real-float-ctors/dist'),T=require('@stdlib/array-base-filled-by/dist'),Z=require('@stdlib/strided-base-nullary/dist'),_=require('@stdlib/strided-base-binary/dist'),j=require('@stdlib/error-tools-fmtprodmsg/dist'),$=b(),m=O();function ee(){var t,r,v,e,a,s;if(v={dtype:$.dtype},r=arguments.length,r===0)a=p,e=P;else if(r===1){if(t=arguments[0],a=p.factory(t),s=m(v,t),s)throw s;e=P}else if(r===2)a=p.factory(arguments[0],arguments[1]),e=L;else if(r===3){if(t=arguments[2],a=p.factory(arguments[0],arguments[1],t),s=m(v,t),s)throw s;e=L}return t&&t.prng?(d(e,"seed",null),d(e,"seedLength",null),x(e,"state",U(null),X),d(e,"stateLength",null),d(e,"byteLength",null)):(l(e,"seed",B),l(e,"seedLength",D),x(e,"state",Y,k),l(e,"stateLength",I),l(e,"byteLength",W)),d(e,"PRNG",a.PRNG),e;function L(n,c){var f,g,o,i,u;if(!S(n))throw new TypeError(j('1eR2d',n));if(u={},arguments.length>1&&(o=m(u,c),o))throw o;return i=u.dtype||v.dtype,i==="generic"?T(n,a):(f=E(i),g=new f(n),Z([g],[n],[1],a),g)}function P(n,c,f,g){var o,i,u,h,q;if(!S(n))throw new TypeError(j('1eR2d',n));if(q={},arguments.length>3&&(u=m(q,g),u))throw u;if(h=q.dtype||v.dtype,h==="generic")return T(n,C);return o=E(h),i=new o(n),_([[c],[f],i],[n],[0,0,1],a),i;function C(){return a(c,f)}}function B(){return e.PRNG.seed}function D(){return e.PRNG.seedLength}function I(){return e.PRNG.stateLength}function W(){return e.PRNG.byteLength}function Y(){return e.PRNG.state}function k(n){e.PRNG.state=n}}F.exports=ee -});var A=y(function(ve,V){ -var re=R(),te=re();V.exports=te -});var ne=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),z=A(),ae=R();ne(z,"factory",ae);module.exports=z; -/** @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 fcb8851..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/defaults.json", "../lib/validate.js", "../lib/factory.js", "../lib/main.js", "../lib/index.js"], - "sourcesContent": ["{\n\t\"dtype\": \"float64\"\n}\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 dtypes = require( '@stdlib/array-typed-real-float-dtypes' );\nvar isObject = require( '@stdlib/assert-is-plain-object' );\nvar hasOwnProp = require( '@stdlib/assert-has-own-property' );\nvar format = require( '@stdlib/string-format' );\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes();\nDTYPES.push( 'generic' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( DTYPES.indexOf( opts.dtype ) < 0 ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be one of the following: \"%s\". Option: `%s`.', 'dtype', DTYPES.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nmodule.exports = validate;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive;\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar setReadOnlyAccessor = require( '@stdlib/utils-define-nonenumerable-read-only-accessor' );\nvar setReadWriteAccessor = require( '@stdlib/utils-define-nonenumerable-read-write-accessor' );\nvar constantFunction = require( '@stdlib/utils-constant-function' );\nvar noop = require( '@stdlib/utils-noop' );\nvar base = require( '@stdlib/random-base-uniform' );\nvar ctors = require( '@stdlib/array-typed-real-float-ctors' );\nvar filledBy = require( '@stdlib/array-base-filled-by' );\nvar nullary = require( '@stdlib/strided-base-nullary' );\nvar binary = require( '@stdlib/strided-base-binary' );\nvar format = require( '@stdlib/string-format' );\nvar defaults = require( './defaults.json' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution.\n*\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\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 {RangeError} `a` must be less than `b`\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 uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10 );\n* // returns \n*\n* @example\n* var uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nfunction factory() {\n\tvar options;\n\tvar nargs;\n\tvar opts;\n\tvar rand;\n\tvar prng;\n\tvar err;\n\n\topts = {\n\t\t'dtype': defaults.dtype\n\t};\n\n\tnargs = arguments.length;\n\tif ( nargs === 0 ) {\n\t\tprng = base;\n\t\trand = uniform2;\n\t} else if ( nargs === 1 ) {\n\t\toptions = arguments[ 0 ];\n\t\tprng = base.factory( options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform2;\n\t} else if ( nargs === 2 ) {\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ] );\n\t\trand = uniform1;\n\t} else if ( nargs === 3 ) {\n\t\toptions = arguments[ 2 ];\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ], options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform1;\n\t}\n\tif ( options && options.prng ) {\n\t\tsetReadOnly( rand, 'seed', null );\n\t\tsetReadOnly( rand, 'seedLength', null );\n\t\tsetReadWriteAccessor( rand, 'state', constantFunction( null ), noop );\n\t\tsetReadOnly( rand, 'stateLength', null );\n\t\tsetReadOnly( rand, 'byteLength', null );\n\t} else {\n\t\tsetReadOnlyAccessor( rand, 'seed', getSeed );\n\t\tsetReadOnlyAccessor( rand, 'seedLength', getSeedLength );\n\t\tsetReadWriteAccessor( rand, 'state', getState, setState );\n\t\tsetReadOnlyAccessor( rand, 'stateLength', getStateLength );\n\t\tsetReadOnlyAccessor( rand, 'byteLength', getStateSize );\n\t}\n\tsetReadOnly( rand, 'PRNG', prng.PRNG );\n\treturn rand;\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform1( len, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 1 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, prng );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tnullary( [ out ], [ len ], [ 1 ], prng );\n\t\treturn out;\n\t}\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {number} a - minimum support\n\t* @param {number} b - maximum support\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform2( len, a, b, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 3 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\t// NOTE: we could alternatively use the PRNG factory function to create a PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. Decision made here to avoid this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom number. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in a return value of `NaN`.\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, wrapper );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tbinary( [ [ a ], [ b ], out ], [ len ], [ 0, 0, 1 ], prng );\n\t\treturn out;\n\n\t\t/**\n\t\t* Applies parameters to a pseudorandom number generator function.\n\t\t*\n\t\t* @private\n\t\t* @returns {number} pseudorandom number\n\t\t*/\n\t\tfunction wrapper() {\n\t\t\treturn prng( a, b );\n\t\t}\n\t}\n\n\t/**\n\t* Returns the PRNG seed.\n\t*\n\t* @private\n\t* @returns {PRNGSeedMT19937} seed\n\t*/\n\tfunction getSeed() {\n\t\treturn rand.PRNG.seed;\n\t}\n\n\t/**\n\t* Returns the PRNG seed length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} seed length\n\t*/\n\tfunction getSeedLength() {\n\t\treturn rand.PRNG.seedLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state length\n\t*/\n\tfunction getStateLength() {\n\t\treturn rand.PRNG.stateLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state size (in bytes).\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state size (in bytes)\n\t*/\n\tfunction getStateSize() {\n\t\treturn rand.PRNG.byteLength;\n\t}\n\n\t/**\n\t* Returns the current pseudorandom number generator state.\n\t*\n\t* @private\n\t* @returns {PRNGStateMT19937} current state\n\t*/\n\tfunction getState() {\n\t\treturn rand.PRNG.state;\n\t}\n\n\t/**\n\t* Sets the pseudorandom number generator state.\n\t*\n\t* @private\n\t* @param {PRNGStateMT19937} s - generator state\n\t* @throws {Error} must provide a valid state\n\t*/\n\tfunction setState( s ) {\n\t\trand.PRNG.state = s;\n\t}\n}\n\n\n// EXPORTS //\n\nmodule.exports = factory;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @name uniform\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\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 = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar uniform = factory();\n\n\n// EXPORTS //\n\nmodule.exports = uniform;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @module @stdlib/random-array-uniform\n*\n* @example\n* var uniform = require( '@stdlib/random-array-uniform' );\n*\n* var arr = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var uniform = require( '@stdlib/random-array-uniform' );\n*\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* var uniform = require( '@stdlib/random-array-uniform' );\n*\n* var rand = uniform.factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* var uniform = require( '@stdlib/random-array-uniform' );\n*\n* var rand = uniform.factory( 2.0, 5.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\" }\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,GAAAC,EAAA,CAAAA,EAAA,SACC,MAAS,SACV,ICFA,IAAAC,EAAAC,EAAA,SAAAC,GAAAC,EAAA,cAsBA,IAAIC,EAAS,QAAS,uCAAwC,EAC1DC,EAAW,QAAS,gCAAiC,EACrDC,EAAa,QAAS,iCAAkC,EACxDC,EAAS,QAAS,uBAAwB,EAK1CC,EAASJ,EAAO,EACpBI,EAAO,KAAM,SAAU,EAwBvB,SAASC,EAAUC,EAAMC,EAAU,CAClC,OAAMN,EAAUM,CAAQ,EAGnBL,EAAYK,EAAS,OAAQ,IACjCD,EAAK,MAAQC,EAAQ,MAChBH,EAAO,QAASE,EAAK,KAAM,EAAI,GAC5B,IAAI,UAAWH,EAAQ,gFAAiF,QAASC,EAAO,KAAM,MAAO,EAAGE,EAAK,KAAM,CAAE,EAGvJ,KARC,IAAI,UAAWH,EAAQ,qEAAsEI,CAAQ,CAAE,CAShH,CAKAR,EAAO,QAAUM,ICvEjB,IAAAG,EAAAC,EAAA,SAAAC,GAAAC,EAAA,cAsBA,IAAIC,EAAuB,QAAS,uCAAwC,EAAE,YAC1EC,EAAc,QAAS,uDAAwD,EAC/EC,EAAsB,QAAS,uDAAwD,EACvFC,EAAuB,QAAS,wDAAyD,EACzFC,EAAmB,QAAS,iCAAkC,EAC9DC,EAAO,QAAS,oBAAqB,EACrCC,EAAO,QAAS,6BAA8B,EAC9CC,EAAQ,QAAS,sCAAuC,EACxDC,EAAW,QAAS,8BAA+B,EACnDC,EAAU,QAAS,8BAA+B,EAClDC,EAAS,QAAS,6BAA8B,EAChDC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IACXC,EAAW,IAwCf,SAASC,IAAU,CAClB,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EAOJ,GALAH,EAAO,CACN,MAASL,EAAS,KACnB,EAEAI,EAAQ,UAAU,OACbA,IAAU,EACdG,EAAOb,EACPY,EAAOG,UACIL,IAAU,EAAI,CAIzB,GAHAD,EAAU,UAAW,CAAE,EACvBI,EAAOb,EAAK,QAASS,CAAQ,EAC7BK,EAAMP,EAAUI,EAAMF,CAAQ,EACzBK,EACJ,MAAMA,EAEPF,EAAOG,CACR,SAAYL,IAAU,EACrBG,EAAOb,EAAK,QAAS,UAAW,CAAE,EAAG,UAAW,CAAE,CAAE,EACpDY,EAAOI,UACIN,IAAU,EAAI,CAIzB,GAHAD,EAAU,UAAW,CAAE,EACvBI,EAAOb,EAAK,QAAS,UAAW,CAAE,EAAG,UAAW,CAAE,EAAGS,CAAQ,EAC7DK,EAAMP,EAAUI,EAAMF,CAAQ,EACzBK,EACJ,MAAMA,EAEPF,EAAOI,CACR,CACA,OAAKP,GAAWA,EAAQ,MACvBd,EAAaiB,EAAM,OAAQ,IAAK,EAChCjB,EAAaiB,EAAM,aAAc,IAAK,EACtCf,EAAsBe,EAAM,QAASd,EAAkB,IAAK,EAAGC,CAAK,EACpEJ,EAAaiB,EAAM,cAAe,IAAK,EACvCjB,EAAaiB,EAAM,aAAc,IAAK,IAEtChB,EAAqBgB,EAAM,OAAQK,CAAQ,EAC3CrB,EAAqBgB,EAAM,aAAcM,CAAc,EACvDrB,EAAsBe,EAAM,QAASO,EAAUC,CAAS,EACxDxB,EAAqBgB,EAAM,cAAeS,CAAe,EACzDzB,EAAqBgB,EAAM,aAAcU,CAAa,GAEvD3B,EAAaiB,EAAM,OAAQC,EAAK,IAAK,EAC9BD,EAcP,SAASI,EAAUO,EAAKd,EAAU,CACjC,IAAIe,EACAC,EACAX,EACAY,EACAC,EACJ,GAAK,CAACjC,EAAsB6B,CAAI,EAC/B,MAAM,IAAI,UAAWlB,EAAQ,+EAAgFkB,CAAI,CAAE,EAGpH,GADAI,EAAI,CAAC,EACA,UAAU,OAAS,IACvBb,EAAMP,EAAUoB,EAAGlB,CAAQ,EACtBK,GACJ,MAAMA,EAIR,OADAY,EAAKC,EAAE,OAAShB,EAAK,MAChBe,IAAO,UACJxB,EAAUqB,EAAKV,CAAK,GAE5BW,EAAOvB,EAAOyB,CAAG,EACjBD,EAAM,IAAID,EAAMD,CAAI,EACpBpB,EAAS,CAAEsB,CAAI,EAAG,CAAEF,CAAI,EAAG,CAAE,CAAE,EAAGV,CAAK,EAChCY,EACR,CAgBA,SAASV,EAAUQ,EAAKK,EAAGC,EAAGpB,EAAU,CACvC,IAAIe,EACAC,EACAX,EACAY,EACAC,EACJ,GAAK,CAACjC,EAAsB6B,CAAI,EAC/B,MAAM,IAAI,UAAWlB,EAAQ,+EAAgFkB,CAAI,CAAE,EAGpH,GADAI,EAAI,CAAC,EACA,UAAU,OAAS,IACvBb,EAAMP,EAAUoB,EAAGlB,CAAQ,EACtBK,GACJ,MAAMA,EAKR,GADAY,EAAKC,EAAE,OAAShB,EAAK,MAChBe,IAAO,UACX,OAAOxB,EAAUqB,EAAKO,CAAQ,EAE/B,OAAAN,EAAOvB,EAAOyB,CAAG,EACjBD,EAAM,IAAID,EAAMD,CAAI,EACpBnB,EAAQ,CAAE,CAAEwB,CAAE,EAAG,CAAEC,CAAE,EAAGJ,CAAI,EAAG,CAAEF,CAAI,EAAG,CAAE,EAAG,EAAG,CAAE,EAAGV,CAAK,EACnDY,EAQP,SAASK,GAAU,CAClB,OAAOjB,EAAMe,EAAGC,CAAE,CACnB,CACD,CAQA,SAASZ,GAAU,CAClB,OAAOL,EAAK,KAAK,IAClB,CAQA,SAASM,GAAgB,CACxB,OAAON,EAAK,KAAK,UAClB,CAQA,SAASS,GAAiB,CACzB,OAAOT,EAAK,KAAK,WAClB,CAQA,SAASU,GAAe,CACvB,OAAOV,EAAK,KAAK,UAClB,CAQA,SAASO,GAAW,CACnB,OAAOP,EAAK,KAAK,KAClB,CASA,SAASQ,EAAUW,EAAI,CACtBnB,EAAK,KAAK,MAAQmB,CACnB,CACD,CAKAtC,EAAO,QAAUe,KCzRjB,IAAAwB,EAAAC,EAAA,SAAAC,GAAAC,EAAA,cAsBA,IAAIC,GAAU,IA8BVC,GAAUD,GAAQ,EAKtBD,EAAO,QAAUE,KCKjB,IAAIC,GAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,GAAU,IAKdF,GAAaC,EAAM,UAAWC,EAAQ,EAKtC,OAAO,QAAUD", - "names": ["require_defaults", "__commonJSMin", "exports", "module", "require_validate", "__commonJSMin", "exports", "module", "dtypes", "isObject", "hasOwnProp", "format", "DTYPES", "validate", "opts", "options", "require_factory", "__commonJSMin", "exports", "module", "isNonNegativeInteger", "setReadOnly", "setReadOnlyAccessor", "setReadWriteAccessor", "constantFunction", "noop", "base", "ctors", "filledBy", "nullary", "binary", "format", "defaults", "validate", "factory", "options", "nargs", "opts", "rand", "prng", "err", "uniform2", "uniform1", "getSeed", "getSeedLength", "getState", "setState", "getStateLength", "getStateSize", "len", "ctor", "out", "dt", "o", "a", "b", "wrapper", "s", "require_main", "__commonJSMin", "exports", "module", "factory", "uniform", "setReadOnly", "main", "factory"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 256216a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,169 +0,0 @@ - -{{alias}}( len, a, b[, options] ) - Returns an array containing pseudorandom numbers drawn from a continuous - uniform distribution. - - Parameters - ---------- - len: integer - Output array length. - - a: number - Minimum support. - - b: number - Maximum support. - - 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 ) - - - -{{alias}}.factory( [a, b, ][options] ) - Returns a function for creating arrays containing pseudorandom numbers drawn - from a continuous uniform distribution. - - If provided `a` and `b`, the returned function returns random variates drawn - from the specified distribution. - - If not provided `a` and `b`, the returned function requires that both `a` - and `b` 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. - - 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 ) - - - // Provide distribution parameters: - > fcn = {{alias}}.factory( 2.0, 5.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 ) - - - // Get a copy of the current state: - > var state = {{alias}}.state - - - > out = {{alias}}( 3, 2.0, 5.0 ) - - > out = {{alias}}( 3, 2.0, 5.0 ) - - - // Set the state: - > {{alias}}.state = state; - - // Regenerate a previous array: - > out = {{alias}}( 3, 2.0, 5.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 a087b98..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,355 +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. -*/ - -import random = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - random( 10, 2, 3 ); // $ExpectType RandomArray - random( 10, 1, 2 ); // $ExpectType RandomArray - random( 10, 1, 2, {} ); // $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 ); // $ExpectError - random( true, 2.0, 5.0 ); // $ExpectError - random( false, 2.0, 5.0 ); // $ExpectError - random( null, 2.0, 5.0 ); // $ExpectError - random( [], 2.0, 5.0 ); // $ExpectError - random( {}, 2.0, 5.0 ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - random( '5', 2.0, 5.0, {} ); // $ExpectError - random( true, 2.0, 5.0, {} ); // $ExpectError - random( false, 2.0, 5.0, {} ); // $ExpectError - random( null, 2.0, 5.0, {} ); // $ExpectError - random( [], 2.0, 5.0, {} ); // $ExpectError - random( {}, 2.0, 5.0, {} ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.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 ); // $ExpectError - random( 10, true, 5.0 ); // $ExpectError - random( 10, false, 5.0 ); // $ExpectError - random( 10, null, 5.0 ); // $ExpectError - random( 10, [], 5.0 ); // $ExpectError - random( 10, {}, 5.0 ); // $ExpectError - random( 10, ( x: number ): number => x, 5.0 ); // $ExpectError - - random( 10, '5', 5.0, {} ); // $ExpectError - random( 10, true, 5.0, {} ); // $ExpectError - random( 10, false, 5.0, {} ); // $ExpectError - random( 10, null, 5.0, {} ); // $ExpectError - random( 10, [], 5.0, {} ); // $ExpectError - random( 10, {}, 5.0, {} ); // $ExpectError - random( 10, ( x: number ): number => x, 5.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' ); // $ExpectError - random( 10, 2.0, true ); // $ExpectError - random( 10, 2.0, false ); // $ExpectError - random( 10, 2.0, null ); // $ExpectError - random( 10, 2.0, [] ); // $ExpectError - random( 10, 2.0, {} ); // $ExpectError - random( 10, 2.0, ( x: number ): number => x ); // $ExpectError - - random( 10, 2.0, '5', {} ); // $ExpectError - random( 10, 2.0, true, {} ); // $ExpectError - random( 10, 2.0, false, {} ); // $ExpectError - random( 10, 2.0, null, {} ); // $ExpectError - random( 10, 2.0, [], {} ); // $ExpectError - random( 10, 2.0, {}, {} ); // $ExpectError - random( 10, 2.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, '5' ); // $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, [] ); // $ExpectError - random( 10, 2.0, 5.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, { 'dtype': 123 } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': null } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - random( 10, 2.0, 5.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 -} - -// Attached to main export is a `factory` method which returns a function... -{ - random.factory( 2.0, 5.0 ); // $ExpectType UnaryFunction - random.factory( 2.0, 5.0, { 'copy': false } ); // $ExpectType UnaryFunction - - random.factory(); // $ExpectType TernaryFunction - random.factory( { 'copy': false } ); // $ExpectType TernaryFunction -} - -// The `factory` method returns a function which returns an array... -{ - const fcn1 = random.factory( 2.0, 5.0 ); - fcn1( 10 ); // $ExpectType RandomArray - - const fcn2 = random.factory(); - fcn2( 10, 2.0, 5.0 ); // $ExpectType RandomArray -} - -// The compiler throws an error if the `factory` method is provided invalid arguments... -{ - random.factory( '5', 5.0 ); // $ExpectError - random.factory( true, 5.0 ); // $ExpectError - random.factory( false, 5.0 ); // $ExpectError - random.factory( [], 5.0 ); // $ExpectError - random.factory( {}, 5.0 ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0 ); // $ExpectError - - random.factory( '5', 5.0, {} ); // $ExpectError - random.factory( true, 5.0, {} ); // $ExpectError - random.factory( false, 5.0, {} ); // $ExpectError - random.factory( [], 5.0, {} ); // $ExpectError - random.factory( {}, 5.0, {} ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0, {} ); // $ExpectError - - random.factory( 2.0, '5' ); // $ExpectError - random.factory( 2.0, true ); // $ExpectError - random.factory( 2.0, false ); // $ExpectError - random.factory( 2.0, [] ); // $ExpectError - random.factory( 2.0, {} ); // $ExpectError - random.factory( 2.0, ( x: number ): number => x ); // $ExpectError - - random.factory( 2.0, '5', {} ); // $ExpectError - random.factory( 2.0, true, {} ); // $ExpectError - random.factory( 2.0, false, {} ); // $ExpectError - random.factory( 2.0, [], {} ); // $ExpectError - random.factory( 2.0, {}, {} ); // $ExpectError - random.factory( 2.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, 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, { 'prng': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'seed': true } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': [ 'a' ] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'state': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': {} } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': true ); // $ExpectError - random.factory( 2.0, 5.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, { 'copy': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'dtype': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - random.factory( 2.0, 5.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, {}, {} ); // $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 ); - 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 ); // $ExpectError - fcn2( false, 2.0, 5.0 ); // $ExpectError - fcn2( '5', 2.0, 5.0 ); // $ExpectError - fcn2( [], 2.0, 5.0 ); // $ExpectError - fcn2( {}, 2.0, 5.0 ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - fcn2( true, 2.0, 5.0, {} ); // $ExpectError - fcn2( false, 2.0, 5.0, {} ); // $ExpectError - fcn2( '5', 2.0, 5.0, {} ); // $ExpectError - fcn2( [], 2.0, 5.0, {} ); // $ExpectError - fcn2( {}, 2.0, 5.0, {} ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0, {} ); // $ExpectError - - fcn2( 10, true, 5.0 ); // $ExpectError - fcn2( 10, false, 5.0 ); // $ExpectError - fcn2( 10, '5', 5.0 ); // $ExpectError - fcn2( 10, [], 5.0 ); // $ExpectError - fcn2( 10, {}, 5.0 ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0 ); // $ExpectError - - fcn2( 10, true, 5.0, {} ); // $ExpectError - fcn2( 10, false, 5.0, {} ); // $ExpectError - fcn2( 10, '5', 5.0, {} ); // $ExpectError - fcn2( 10, [], 5.0, {} ); // $ExpectError - fcn2( 10, {}, 5.0, {} ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0, {} ); // $ExpectError - - fcn2( 10, 2.0, true ); // $ExpectError - fcn2( 10, 2.0, false ); // $ExpectError - fcn2( 10, 2.0, '5' ); // $ExpectError - fcn2( 10, 2.0, [] ); // $ExpectError - fcn2( 10, 2.0, {} ); // $ExpectError - fcn2( 10, 2.0, ( x: number ): number => x ); // $ExpectError - - fcn2( 10, 2.0, true, {} ); // $ExpectError - fcn2( 10, 2.0, false, {} ); // $ExpectError - fcn2( 10, 2.0, '5', {} ); // $ExpectError - fcn2( 10, 2.0, [], {} ); // $ExpectError - fcn2( 10, 2.0, {}, {} ); // $ExpectError - fcn2( 10, 2.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, { 'dtype': 123 } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': null } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError - - const fcn2 = random.factory( 2.0, 5.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 ); - fcn1(); // $ExpectError - fcn1( 1, 1, 1 ); // $ExpectError - - const fcn2 = random.factory(); - fcn2(); // $ExpectError - fcn2( 1 ); // $ExpectError - fcn2( 1, 1, 1, 1 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index c485546..0000000 --- a/examples/index.js +++ /dev/null @@ -1,48 +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'; - -var logEach = require( '@stdlib/console-log-each' ); -var uniform = require( './../lib' ); - -// Create a function for generating random arrays originating from the same state: -var random = uniform.factory( 2.0, 5.0, { - 'state': uniform.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 = uniform.factory( 2.0, 5.0, { - 'state': uniform.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 6fef7d9..e49ce72 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { FloatDataType, 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..8feff68 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.1.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-accessor@v0.1.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-write-accessor@v0.1.0-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-constant-function@v0.1.0-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-noop@v0.1.0-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/random-base-uniform@v0.1.0-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-typed-real-float-ctors@v0.1.0-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@v0.1.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-nullary@v0.1.0-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@v0.1.0-esm/index.mjs";import f from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.1.0-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/array-typed-real-float-dtypes@v0.1.0-esm/index.mjs";import h from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.1.0-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.1.0-esm/index.mjs";var c="float64",u=a();function g(e,t){return h(t)?j(t,"dtype")&&(e.dtype=t.dtype,u.indexOf(e.dtype)<0)?new TypeError(f("1eR2X,3g,4S,GD,Gg,Jm","dtype",u.join('", "'),e.dtype)):null:new TypeError(f("1eR2V,FD",t))}function v(){var a,h,j,u,v,y;if(j={dtype:c},0===(h=arguments.length))v=d,u=x;else if(1===h){if(a=arguments[0],v=d.factory(a),y=g(j,a))throw y;u=x}else if(2===h)v=d.factory(arguments[0],arguments[1]),u=b;else if(3===h){if(a=arguments[2],v=d.factory(arguments[0],arguments[1],a),y=g(j,a))throw y;u=b}return a&&a.prng?(e(u,"seed",null),e(u,"seedLength",null),n(u,"state",r(null),i),e(u,"stateLength",null),e(u,"byteLength",null)):(s(u,"seed",w),s(u,"seedLength",G),n(u,"state",N,P),s(u,"stateLength",R),s(u,"byteLength",L)),e(u,"PRNG",v.PRNG),u;function b(e,s){var n,r,i,d;if(!t(e))throw new TypeError(f("1eR2d,MG",e));if(d={},arguments.length>1&&(r=g(d,s)))throw r;return"generic"===(i=d.dtype||j.dtype)?l(e,v):(n=new(o(i))(e),m([n],[e],[1],v),n)}function x(e,s,n,r){var i,d,m,a;if(!t(e))throw new TypeError(f("1eR2d,MG",e));if(a={},arguments.length>3&&(d=g(a,r)))throw d;return"generic"===(m=a.dtype||j.dtype)?l(e,h):(i=new(o(m))(e),p([[s],[n],i],[e],[0,0,1],v),i);function h(){return v(s,n)}}function w(){return u.PRNG.seed}function G(){return u.PRNG.seedLength}function R(){return u.PRNG.stateLength}function L(){return u.PRNG.byteLength}function N(){return u.PRNG.state}function P(e){u.PRNG.state=e}}u.push("generic");var y=v();e(y,"factory",v);export{y as default,v as factory}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..f442194 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/factory.js","../lib/main.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 dtypes from '@stdlib/array-typed-real-float-dtypes';\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes();\nDTYPES.push( 'generic' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '1eR2V,FD', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( DTYPES.indexOf( opts.dtype ) < 0 ) {\n\t\t\treturn new TypeError( format( '1eR2X,3g,4S,GD,Gg,Jm', 'dtype', DTYPES.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport setReadOnlyAccessor from '@stdlib/utils-define-nonenumerable-read-only-accessor';\nimport setReadWriteAccessor from '@stdlib/utils-define-nonenumerable-read-write-accessor';\nimport constantFunction from '@stdlib/utils-constant-function';\nimport noop from '@stdlib/utils-noop';\nimport base from '@stdlib/random-base-uniform';\nimport ctors from '@stdlib/array-typed-real-float-ctors';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport nullary from '@stdlib/strided-base-nullary';\nimport binary from '@stdlib/strided-base-binary';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution.\n*\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\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 {RangeError} `a` must be less than `b`\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 uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10 );\n* // returns \n*\n* @example\n* var uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nfunction factory() {\n\tvar options;\n\tvar nargs;\n\tvar opts;\n\tvar rand;\n\tvar prng;\n\tvar err;\n\n\topts = {\n\t\t'dtype': defaults.dtype\n\t};\n\n\tnargs = arguments.length;\n\tif ( nargs === 0 ) {\n\t\tprng = base;\n\t\trand = uniform2;\n\t} else if ( nargs === 1 ) {\n\t\toptions = arguments[ 0 ];\n\t\tprng = base.factory( options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform2;\n\t} else if ( nargs === 2 ) {\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ] );\n\t\trand = uniform1;\n\t} else if ( nargs === 3 ) {\n\t\toptions = arguments[ 2 ];\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ], options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform1;\n\t}\n\tif ( options && options.prng ) {\n\t\tsetReadOnly( rand, 'seed', null );\n\t\tsetReadOnly( rand, 'seedLength', null );\n\t\tsetReadWriteAccessor( rand, 'state', constantFunction( null ), noop );\n\t\tsetReadOnly( rand, 'stateLength', null );\n\t\tsetReadOnly( rand, 'byteLength', null );\n\t} else {\n\t\tsetReadOnlyAccessor( rand, 'seed', getSeed );\n\t\tsetReadOnlyAccessor( rand, 'seedLength', getSeedLength );\n\t\tsetReadWriteAccessor( rand, 'state', getState, setState );\n\t\tsetReadOnlyAccessor( rand, 'stateLength', getStateLength );\n\t\tsetReadOnlyAccessor( rand, 'byteLength', getStateSize );\n\t}\n\tsetReadOnly( rand, 'PRNG', prng.PRNG );\n\treturn rand;\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform1( len, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( '1eR2d,MG', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 1 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, prng );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tnullary( [ out ], [ len ], [ 1 ], prng );\n\t\treturn out;\n\t}\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {number} a - minimum support\n\t* @param {number} b - maximum support\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform2( len, a, b, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( '1eR2d,MG', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 3 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\t// NOTE: we could alternatively use the PRNG factory function to create a PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. Decision made here to avoid this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom number. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in a return value of `NaN`.\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, wrapper );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tbinary( [ [ a ], [ b ], out ], [ len ], [ 0, 0, 1 ], prng );\n\t\treturn out;\n\n\t\t/**\n\t\t* Applies parameters to a pseudorandom number generator function.\n\t\t*\n\t\t* @private\n\t\t* @returns {number} pseudorandom number\n\t\t*/\n\t\tfunction wrapper() {\n\t\t\treturn prng( a, b );\n\t\t}\n\t}\n\n\t/**\n\t* Returns the PRNG seed.\n\t*\n\t* @private\n\t* @returns {PRNGSeedMT19937} seed\n\t*/\n\tfunction getSeed() {\n\t\treturn rand.PRNG.seed;\n\t}\n\n\t/**\n\t* Returns the PRNG seed length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} seed length\n\t*/\n\tfunction getSeedLength() {\n\t\treturn rand.PRNG.seedLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state length\n\t*/\n\tfunction getStateLength() {\n\t\treturn rand.PRNG.stateLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state size (in bytes).\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state size (in bytes)\n\t*/\n\tfunction getStateSize() {\n\t\treturn rand.PRNG.byteLength;\n\t}\n\n\t/**\n\t* Returns the current pseudorandom number generator state.\n\t*\n\t* @private\n\t* @returns {PRNGStateMT19937} current state\n\t*/\n\tfunction getState() {\n\t\treturn rand.PRNG.state;\n\t}\n\n\t/**\n\t* Sets the pseudorandom number generator state.\n\t*\n\t* @private\n\t* @param {PRNGStateMT19937} s - generator state\n\t* @throws {Error} must provide a valid state\n\t*/\n\tfunction setState( s ) {\n\t\trand.PRNG.state = s;\n\t}\n}\n\n\n// EXPORTS //\n\nexport default factory;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @name uniform\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\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 = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar uniform = factory();\n\n\n// EXPORTS //\n\nexport default uniform;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @module @stdlib/random-array-uniform\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.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\" }\n"],"names":["DTYPES","dtypes","validate","opts","options","isObject","hasOwnProp","dtype","indexOf","TypeError","format","join","factory","nargs","rand","prng","err","defaults","arguments","length","base","uniform2","uniform1","setReadOnly","setReadWriteAccessor","constantFunction","noop","setReadOnlyAccessor","getSeed","getSeedLength","getState","setState","getStateLength","getStateSize","PRNG","len","out","dt","o","isNonNegativeInteger","filledBy","ctors","nullary","a","b","wrapper","binary","seed","seedLength","stateLength","byteLength","state","s","push","uniform","main"],"mappings":";;ohDA8BIA,EAASC,IAyBb,SAASC,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,WACzBD,EAAKI,MAAQH,EAAQG,MAChBP,EAAOQ,QAASL,EAAKI,OAAU,GAC5B,IAAIE,UAAWC,EAAQ,uBAAwB,QAASV,EAAOW,KAAM,QAAUR,EAAKI,QAGtF,KARC,IAAIE,UAAWC,EAAQ,WAAYN,GAS5C,CCSA,SAASQ,IACR,IAAIR,EACAS,EACAV,EACAW,EACAC,EACAC,EAOJ,GALAb,EAAO,CACNI,MAASU,GAIK,KADfJ,EAAQK,UAAUC,QAEjBJ,EAAOK,EACPN,EAAOO,OACD,GAAe,IAAVR,EAAc,CAIzB,GAHAT,EAAUc,UAAW,GACrBH,EAAOK,EAAKR,QAASR,GACrBY,EAAMd,EAAUC,EAAMC,GAErB,MAAMY,EAEPF,EAAOO,CACT,MAAQ,GAAe,IAAVR,EACXE,EAAOK,EAAKR,QAASM,UAAW,GAAKA,UAAW,IAChDJ,EAAOQ,OACD,GAAe,IAAVT,EAAc,CAIzB,GAHAT,EAAUc,UAAW,GACrBH,EAAOK,EAAKR,QAASM,UAAW,GAAKA,UAAW,GAAKd,GACrDY,EAAMd,EAAUC,EAAMC,GAErB,MAAMY,EAEPF,EAAOQ,CACP,CAeD,OAdKlB,GAAWA,EAAQW,MACvBQ,EAAaT,EAAM,OAAQ,MAC3BS,EAAaT,EAAM,aAAc,MACjCU,EAAsBV,EAAM,QAASW,EAAkB,MAAQC,GAC/DH,EAAaT,EAAM,cAAe,MAClCS,EAAaT,EAAM,aAAc,QAEjCa,EAAqBb,EAAM,OAAQc,GACnCD,EAAqBb,EAAM,aAAce,GACzCL,EAAsBV,EAAM,QAASgB,EAAUC,GAC/CJ,EAAqBb,EAAM,cAAekB,GAC1CL,EAAqBb,EAAM,aAAcmB,IAE1CV,EAAaT,EAAM,OAAQC,EAAKmB,MACzBpB,EAcP,SAASQ,EAAUa,EAAK/B,GACvB,IACIgC,EACApB,EACAqB,EACAC,EACJ,IAAMC,EAAsBJ,GAC3B,MAAM,IAAI1B,UAAWC,EAAQ,WAAYyB,IAG1C,GADAG,EAAI,CAAA,EACCpB,UAAUC,OAAS,IACvBH,EAAMd,EAAUoC,EAAGlC,IAElB,MAAMY,EAIR,MAAY,aADZqB,EAAKC,EAAE/B,OAASJ,EAAKI,OAEbiC,EAAUL,EAAKpB,IAGvBqB,EAAM,IADCK,EAAOJ,GACR,CAAUF,GAChBO,EAAS,CAAEN,GAAO,CAAED,GAAO,CAAE,GAAKpB,GAC3BqB,EACP,CAgBD,SAASf,EAAUc,EAAKQ,EAAGC,EAAGxC,GAC7B,IACIgC,EACApB,EACAqB,EACAC,EACJ,IAAMC,EAAsBJ,GAC3B,MAAM,IAAI1B,UAAWC,EAAQ,WAAYyB,IAG1C,GADAG,EAAI,CAAA,EACCpB,UAAUC,OAAS,IACvBH,EAAMd,EAAUoC,EAAGlC,IAElB,MAAMY,EAKR,MAAY,aADZqB,EAAKC,EAAE/B,OAASJ,EAAKI,OAEbiC,EAAUL,EAAKU,IAGvBT,EAAM,IADCK,EAAOJ,GACR,CAAUF,GAChBW,EAAQ,CAAE,CAAEH,GAAK,CAAEC,GAAKR,GAAO,CAAED,GAAO,CAAE,EAAG,EAAG,GAAKpB,GAC9CqB,GAQP,SAASS,IACR,OAAO9B,EAAM4B,EAAGC,EAChB,CACD,CAQD,SAAShB,IACR,OAAOd,EAAKoB,KAAKa,IACjB,CAQD,SAASlB,IACR,OAAOf,EAAKoB,KAAKc,UACjB,CAQD,SAAShB,IACR,OAAOlB,EAAKoB,KAAKe,WACjB,CAQD,SAAShB,IACR,OAAOnB,EAAKoB,KAAKgB,UACjB,CAQD,SAASpB,IACR,OAAOhB,EAAKoB,KAAKiB,KACjB,CASD,SAASpB,EAAUqB,GAClBtC,EAAKoB,KAAKiB,MAAQC,CAClB,CACF,CDrPApD,EAAOqD,KAAM,WEqBV,IAACC,EAAU1C,ICiBdW,EAAAgC,EAAA,UAAA3C"} \ No newline at end of file diff --git a/lib/defaults.json b/lib/defaults.json deleted file mode 100644 index 83f4438..0000000 --- a/lib/defaults.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "dtype": "float64" -} diff --git a/lib/factory.js b/lib/factory.js deleted file mode 100644 index 24d5d10..0000000 --- a/lib/factory.js +++ /dev/null @@ -1,282 +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 isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var setReadOnlyAccessor = require( '@stdlib/utils-define-nonenumerable-read-only-accessor' ); -var setReadWriteAccessor = require( '@stdlib/utils-define-nonenumerable-read-write-accessor' ); -var constantFunction = require( '@stdlib/utils-constant-function' ); -var noop = require( '@stdlib/utils-noop' ); -var base = require( '@stdlib/random-base-uniform' ); -var ctors = require( '@stdlib/array-typed-real-float-ctors' ); -var filledBy = require( '@stdlib/array-base-filled-by' ); -var nullary = require( '@stdlib/strided-base-nullary' ); -var binary = require( '@stdlib/strided-base-binary' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution. -* -* @param {number} [a] - minimum support -* @param {number} [b] - maximum support -* @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 {RangeError} `a` must be less than `b` -* @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 uniform = factory( 2.0, 5.0 ); -* // returns -* -* var arr = uniform( 10 ); -* // returns -* -* @example -* var uniform = factory( 2.0, 5.0 ); -* // returns -* -* var arr = uniform( 10, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -function factory() { - var options; - var nargs; - var opts; - var rand; - var prng; - var err; - - opts = { - 'dtype': defaults.dtype - }; - - nargs = arguments.length; - if ( nargs === 0 ) { - prng = base; - rand = uniform2; - } else if ( nargs === 1 ) { - options = arguments[ 0 ]; - prng = base.factory( options ); - err = validate( opts, options ); - if ( err ) { - throw err; - } - rand = uniform2; - } else if ( nargs === 2 ) { - prng = base.factory( arguments[ 0 ], arguments[ 1 ] ); - rand = uniform1; - } else if ( nargs === 3 ) { - options = arguments[ 2 ]; - prng = base.factory( arguments[ 0 ], arguments[ 1 ], options ); - err = validate( opts, options ); - if ( err ) { - throw err; - } - rand = uniform1; - } - if ( options && options.prng ) { - setReadOnly( rand, 'seed', null ); - setReadOnly( rand, 'seedLength', null ); - setReadWriteAccessor( rand, 'state', constantFunction( null ), noop ); - setReadOnly( rand, 'stateLength', null ); - setReadOnly( rand, 'byteLength', null ); - } else { - setReadOnlyAccessor( rand, 'seed', getSeed ); - setReadOnlyAccessor( rand, 'seedLength', getSeedLength ); - setReadWriteAccessor( rand, 'state', getState, setState ); - setReadOnlyAccessor( rand, 'stateLength', getStateLength ); - setReadOnlyAccessor( rand, 'byteLength', getStateSize ); - } - setReadOnly( rand, 'PRNG', prng.PRNG ); - return rand; - - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @private - * @param {NonNegativeInteger} len - array length - * @param {Options} [options] - function options - * @param {string} [options.dtype] - 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 - */ - function uniform1( len, options ) { - var ctor; - var out; - var err; - var dt; - var o; - if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( '1eR2d,MG', len ) ); - } - o = {}; - if ( arguments.length > 1 ) { - err = validate( o, options ); - if ( err ) { - throw err; - } - } - dt = o.dtype || opts.dtype; - if ( dt === 'generic' ) { - return filledBy( len, prng ); - } - ctor = ctors( dt ); - out = new ctor( len ); - nullary( [ out ], [ len ], [ 1 ], prng ); - return out; - } - - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @private - * @param {NonNegativeInteger} len - array length - * @param {number} a - minimum support - * @param {number} b - maximum support - * @param {Options} [options] - function options - * @param {string} [options.dtype] - 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 - */ - function uniform2( len, a, b, options ) { - var ctor; - var out; - var err; - var dt; - var o; - if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( '1eR2d,MG', len ) ); - } - o = {}; - if ( arguments.length > 3 ) { - err = validate( o, options ); - if ( err ) { - throw err; - } - } - // NOTE: we could alternatively use the PRNG factory function to create a PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. Decision made here to avoid this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom number. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in a return value of `NaN`. - dt = o.dtype || opts.dtype; - if ( dt === 'generic' ) { - return filledBy( len, wrapper ); - } - ctor = ctors( dt ); - out = new ctor( len ); - binary( [ [ a ], [ b ], out ], [ len ], [ 0, 0, 1 ], prng ); - return out; - - /** - * Applies parameters to a pseudorandom number generator function. - * - * @private - * @returns {number} pseudorandom number - */ - function wrapper() { - return prng( a, b ); - } - } - - /** - * Returns the PRNG seed. - * - * @private - * @returns {PRNGSeedMT19937} seed - */ - function getSeed() { - return rand.PRNG.seed; - } - - /** - * Returns the PRNG seed length. - * - * @private - * @returns {PositiveInteger} seed length - */ - function getSeedLength() { - return rand.PRNG.seedLength; - } - - /** - * Returns the PRNG state length. - * - * @private - * @returns {PositiveInteger} state length - */ - function getStateLength() { - return rand.PRNG.stateLength; - } - - /** - * Returns the PRNG state size (in bytes). - * - * @private - * @returns {PositiveInteger} state size (in bytes) - */ - function getStateSize() { - return rand.PRNG.byteLength; - } - - /** - * Returns the current pseudorandom number generator state. - * - * @private - * @returns {PRNGStateMT19937} current state - */ - function getState() { - return rand.PRNG.state; - } - - /** - * Sets the pseudorandom number generator state. - * - * @private - * @param {PRNGStateMT19937} s - generator state - * @throws {Error} must provide a valid state - */ - function setState( s ) { - rand.PRNG.state = s; - } -} - - -// EXPORTS // - -module.exports = factory; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 0077f00..0000000 --- a/lib/index.js +++ /dev/null @@ -1,77 +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'; - -/** -* Create an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. -* -* @module @stdlib/random-array-uniform -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var arr = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var arr = uniform( 10, 2.0, 5.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var rand = uniform.factory( 2.0, 5.0 ); -* // returns -* -* var arr = rand( 10 ); -* // returns -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var rand = uniform.factory( 2.0, 5.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" } diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index da0d9b1..0000000 --- a/lib/main.js +++ /dev/null @@ -1,58 +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 factory = require( './factory.js' ); - - -// MAIN // - -/** -* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. -* -* @name uniform -* @type {Function} -* @param {NonNegativeInteger} len - array length -* @param {number} a - minimum support -* @param {number} b - maximum support -* @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 = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var arr = uniform( 10, 2.0, 5.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -var uniform = factory(); - - -// EXPORTS // - -module.exports = uniform; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index 1c3d511..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,72 +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 dtypes = require( '@stdlib/array-typed-real-float-dtypes' ); -var isObject = require( '@stdlib/assert-is-plain-object' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// VARIABLES // - -var DTYPES = dtypes(); -DTYPES.push( 'generic' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Options} options - function options -* @param {string} [options.dtype] - output array data type -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var options = { -* 'dtype': 'float64' -* }; -* var err = validate( opts, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( '1eR2V,FD', options ) ); - } - if ( hasOwnProp( options, 'dtype' ) ) { - opts.dtype = options.dtype; - if ( DTYPES.indexOf( opts.dtype ) < 0 ) { - return new TypeError( format( '1eR2X,3g,4S,GD,Gg,Jm', 'dtype', DTYPES.join( '", "' ), opts.dtype ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index 0c95623..767a213 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 continuous uniform 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,55 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-filled-by": "^0.1.0", - "@stdlib/array-typed-real-float-ctors": "^0.1.0", - "@stdlib/array-typed-real-float-dtypes": "^0.1.0", - "@stdlib/assert-has-own-property": "^0.1.0", - "@stdlib/assert-is-nonnegative-integer": "^0.1.0", - "@stdlib/assert-is-plain-object": "^0.1.0", - "@stdlib/random-base-uniform": "^0.1.0", - "@stdlib/strided-base-binary": "^0.1.0", - "@stdlib/strided-base-nullary": "^0.1.0", - "@stdlib/error-tools-fmtprodmsg": "^0.1.0", - "@stdlib/types": "^0.1.0", - "@stdlib/utils-constant-function": "^0.1.0", - "@stdlib/utils-define-nonenumerable-read-only-accessor": "^0.1.0", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.0", - "@stdlib/utils-define-nonenumerable-read-write-accessor": "^0.1.0", - "@stdlib/utils-noop": "^0.1.0" - }, - "devDependencies": { - "@stdlib/array-float32": "^0.1.0", - "@stdlib/array-float64": "^0.1.0", - "@stdlib/array-uint32": "^0.1.0", - "@stdlib/assert-is-uint32array": "^0.1.0", - "@stdlib/bench": "^0.1.0", - "@stdlib/console-log-each": "^0.1.0", - "@stdlib/constants-uint32-max": "^0.1.0", - "@stdlib/math-base-assert-is-nan": "^0.1.0", - "@stdlib/math-base-assert-is-nanf": "^0.1.0", - "@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" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdmath", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..3e4c148 --- /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 584b08e..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,69 +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 random = require( './../../dist' ); - - -// 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 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.factory.js b/test/test.factory.js deleted file mode 100644 index a869e75..0000000 --- a/test/test.factory.js +++ /dev/null @@ -1,1328 +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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -tape( 'the function throws an error if the second distribution parameter is less than the first distribution parameter', function test( t ) { - var values; - var i; - - values = [ - [ 0.0, 0.0 ], - [ -2.0, -4.0 ], - [ 2.0, 1.0 ] - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( arr ) { - return function badValue() { - factory( arr[0], arr[1] ); - }; - } -}); - -tape( 'the function throws an error if the second distribution parameter is less than the first distribution parameter (options)', function test( t ) { - var values; - var i; - - values = [ - [ 0.0, 0.0 ], - [ -2.0, -4.0 ], - [ 2.0, 1.0 ] - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( arr ) { - return function badValue() { - factory( arr[0], arr[1], {} ); - }; - } -}); - -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, 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, { - '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, { - '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, { - '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, { - '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, { - '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, { - '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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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 ); - - 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 ); - - 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, { - '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 ); - - 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 ); - 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( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory(); - actual = random( 10, 2.0, 5.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( typeof actual[ i ], 'number', '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 ); - - 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 ); - - 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 ); - - 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 that generates `NaN` values if the first distribution parameter is greater than or equal to the second distribution parameter', function test( t ) { - var random; - var values; - var actual; - var i; - var j; - - random = factory(); - values = [ - [ 2.0, 1.0 ], - [ -3.0, -4.0 ], - [ 0.0, 0.0 ] - ]; - - for ( i = 0; i < values.length; i++ ) { - actual = random( 10, values[ i ][ 0 ], values[ i ][ 1 ] ); - for ( j = 0; j < actual.length; j++ ) { - t.strictEqual( isnan( actual[ j ] ), true, 'returns expected value when provided '+values[ 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, { - '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 ); - - 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, { - '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( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'float64' - }); - actual = random( 10, 2.0, 5.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( typeof actual[ i ], 'number', '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, { - '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( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'float32' - }); - actual = random( 10, 2.0, 5.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( typeof actual[ i ], 'number', '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, { - '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 ); - - 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, { - '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, { - '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 ); - - // 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, { - '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 ); - - // 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, { - '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 ); - - 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, { - 'prng': randu.normalized - }); - - randu = minstd.factory({ - 'seed': seed - }); - random2 = factory( 2.0, 5.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 ); - arr2 = random2( 10, 2.0, 5.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 c4fb6d3..0000000 --- a/test/test.js +++ /dev/null @@ -1,69 +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 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 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 37b0080..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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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, 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, { - '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 ); - - 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( typeof actual[ i ], 'number', '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, { - '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( typeof actual[ i ], 'number', '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, { - '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( typeof actual[ i ], 'number', '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, { - '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 ); - } - // Capture the current state: - state = random.state; - - // Move to a future state... - arr = random( 10, 2.0, 5.0 ); - for ( i = 0; i < 100; i++ ) { - random( 2, 2.0, 5.0 ); - } - // Set the state: - random.state = state; - - // Replay previously generated values: - t.deepEqual( random( 10, 2.0, 5.0 ), arr, 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.validate.js b/test/test.validate.js deleted file mode 100644 index 9fbe15f..0000000 --- a/test/test.validate.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 validate = require( './../lib/validate.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof validate, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function returns an error if provided an options argument which is not an object', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - void 0, - null, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, values[ i ] ); - t.equal( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided a `dtype` option which is not a supported data type', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - -5, - NaN, - true, - false, - void 0, - null, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, { - 'dtype': values[ i ] - }); - t.equal( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns null if all options are valid', function test( t ) { - var options; - var opts; - var err; - - options = { - 'dtype': 'float64' - }; - opts = {}; - err = validate( opts, options ); - - t.equal( err, null, 'returns null' ); - t.deepEqual( opts, options, 'sets option values' ); - - t.end(); -}); - -tape( 'the function ignores unrecognized/unsupported options', function test( t ) { - var options; - var opts; - var err; - - options = { - 'beep': true, - 'boop': 'bop' - }; - opts = {}; - err = validate( opts, options ); - - t.equal( err, null, 'returns null' ); - t.deepEqual( opts, {}, 'does not set any option values' ); - t.end(); -}); From cdfd6e6d051dd180b036552d386c2abcc42598d2 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 7 Oct 2023 18:03:37 +0000 Subject: [PATCH 34/82] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index acfa531..920af2f 100644 --- a/package.json +++ b/package.json @@ -46,7 +46,7 @@ "@stdlib/random-base-uniform": "^0.1.0", "@stdlib/strided-base-binary": "^0.1.0", "@stdlib/strided-base-nullary": "^0.1.0", - "@stdlib/string-format": "^0.1.1", + "@stdlib/error-tools-fmtprodmsg": "^0.1.1", "@stdlib/types": "^0.1.0", "@stdlib/utils-constant-function": "^0.1.1", "@stdlib/utils-define-nonenumerable-read-only-accessor": "^0.1.1", From f967eb12da6f76c99a2571412fc542005071d89d Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 7 Oct 2023 20:36:41 +0000 Subject: [PATCH 35/82] Remove files --- index.d.ts | 245 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6427 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 e49ce72..0000000 --- a/index.d.ts +++ /dev/null @@ -1,245 +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. -*/ - -// TypeScript Version: 4.1 - -/// - -import { FloatDataType, FloatTypedArray } from '@stdlib/types/array'; -import * as random from '@stdlib/types/random'; - -/** -* Supported data types. -*/ -type DataType = FloatDataType | 'generic'; - -/** -* 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 continuous uniform distribution with pre-specified parameter values. -*/ -interface UnaryFunction extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @param len - array length - * @param options - function options - * @returns output array - */ - ( len: number, options?: Options ): RandomArray; -} - -/** -* Interface for generating pseudorandom numbers drawn from a continuous uniform distribution without pre-specified parameter values. -*/ -interface TernaryFunction extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @param len - array length - * @param a - minimum support - * @param b - maximum support - * @param options - function options - * @returns output array - */ - ( len: number, a: number, b: number, options?: Options ): RandomArray; -} - -/** -* Interface for generating pseudorandom numbers drawn from a uniform distribution. -*/ -interface Random extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @param len - array length - * @param a - minimum support - * @param b - maximum support - * @param options - function options - * @returns output array - * - * @example - * var out = uniform( 10, 2.0, 5.0 ); - * // returns - */ - ( len: number, a: number, b: number, options?: Options ): RandomArray; - - /** - * Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution. - * - * ## Notes - * - * - When provided `a` and `b`, the returned function returns random variates drawn from the specified distribution. - * - * @param a - minimum support - * @param b - maximum support - * @param options - function options - * @throws `a` must be less than `b` - * @throws must provide a valid state - * @returns function for creating arrays - * - * @example - * var random = uniform.factory( 2.0, 5.0 ); - * - * var out = random( 10 ); - * // returns - * - * @example - * var random = uniform.factory( 2.0, 5.0, { - * 'seed': 297 - * }); - * var out = random( 10 ); - * // returns - */ - factory( a: number, b: number, options?: FactoryOptions ): UnaryFunction; - - /** - * Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution. - * - * ## Notes - * - * - When not provided `a` and `b`, the returned function requires that both `a` and `b` be provided at each invocation. - * - * @param options - function options - * @throws must provide a valid state - * @returns function for creating arrays - * - * @example - * var random = uniform.factory(); - * - * var out = random( 10, 2.0, 5.0 ); - * // returns - * - * @example - * var random = uniform.factory({ - * 'seed': 297 - * }); - * var out = random( 10, 2.0, 5.0 ); - * // returns - */ - factory( options?: FactoryOptions ): TernaryFunction; -} - -/** -* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. -* -* @param len - array length -* @param a - minimum support -* @param b - maximum support -* @param options - function options -* @returns output array -* -* @example -* var out = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var random = uniform.factory( 2.0, 5.0 ); -* -* var out = random( 10 ); -* // returns -*/ -declare var uniform: Random; - - -// EXPORTS // - -export = uniform; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 8feff68..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.1.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-accessor@v0.1.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-write-accessor@v0.1.0-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-constant-function@v0.1.0-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-noop@v0.1.0-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/random-base-uniform@v0.1.0-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-typed-real-float-ctors@v0.1.0-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@v0.1.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-nullary@v0.1.0-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@v0.1.0-esm/index.mjs";import f from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.1.0-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/array-typed-real-float-dtypes@v0.1.0-esm/index.mjs";import h from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.1.0-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.1.0-esm/index.mjs";var c="float64",u=a();function g(e,t){return h(t)?j(t,"dtype")&&(e.dtype=t.dtype,u.indexOf(e.dtype)<0)?new TypeError(f("1eR2X,3g,4S,GD,Gg,Jm","dtype",u.join('", "'),e.dtype)):null:new TypeError(f("1eR2V,FD",t))}function v(){var a,h,j,u,v,y;if(j={dtype:c},0===(h=arguments.length))v=d,u=x;else if(1===h){if(a=arguments[0],v=d.factory(a),y=g(j,a))throw y;u=x}else if(2===h)v=d.factory(arguments[0],arguments[1]),u=b;else if(3===h){if(a=arguments[2],v=d.factory(arguments[0],arguments[1],a),y=g(j,a))throw y;u=b}return a&&a.prng?(e(u,"seed",null),e(u,"seedLength",null),n(u,"state",r(null),i),e(u,"stateLength",null),e(u,"byteLength",null)):(s(u,"seed",w),s(u,"seedLength",G),n(u,"state",N,P),s(u,"stateLength",R),s(u,"byteLength",L)),e(u,"PRNG",v.PRNG),u;function b(e,s){var n,r,i,d;if(!t(e))throw new TypeError(f("1eR2d,MG",e));if(d={},arguments.length>1&&(r=g(d,s)))throw r;return"generic"===(i=d.dtype||j.dtype)?l(e,v):(n=new(o(i))(e),m([n],[e],[1],v),n)}function x(e,s,n,r){var i,d,m,a;if(!t(e))throw new TypeError(f("1eR2d,MG",e));if(a={},arguments.length>3&&(d=g(a,r)))throw d;return"generic"===(m=a.dtype||j.dtype)?l(e,h):(i=new(o(m))(e),p([[s],[n],i],[e],[0,0,1],v),i);function h(){return v(s,n)}}function w(){return u.PRNG.seed}function G(){return u.PRNG.seedLength}function R(){return u.PRNG.stateLength}function L(){return u.PRNG.byteLength}function N(){return u.PRNG.state}function P(e){u.PRNG.state=e}}u.push("generic");var y=v();e(y,"factory",v);export{y as default,v as factory}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index f442194..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/factory.js","../lib/main.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 dtypes from '@stdlib/array-typed-real-float-dtypes';\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes();\nDTYPES.push( 'generic' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '1eR2V,FD', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( DTYPES.indexOf( opts.dtype ) < 0 ) {\n\t\t\treturn new TypeError( format( '1eR2X,3g,4S,GD,Gg,Jm', 'dtype', DTYPES.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport setReadOnlyAccessor from '@stdlib/utils-define-nonenumerable-read-only-accessor';\nimport setReadWriteAccessor from '@stdlib/utils-define-nonenumerable-read-write-accessor';\nimport constantFunction from '@stdlib/utils-constant-function';\nimport noop from '@stdlib/utils-noop';\nimport base from '@stdlib/random-base-uniform';\nimport ctors from '@stdlib/array-typed-real-float-ctors';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport nullary from '@stdlib/strided-base-nullary';\nimport binary from '@stdlib/strided-base-binary';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution.\n*\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\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 {RangeError} `a` must be less than `b`\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 uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10 );\n* // returns \n*\n* @example\n* var uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nfunction factory() {\n\tvar options;\n\tvar nargs;\n\tvar opts;\n\tvar rand;\n\tvar prng;\n\tvar err;\n\n\topts = {\n\t\t'dtype': defaults.dtype\n\t};\n\n\tnargs = arguments.length;\n\tif ( nargs === 0 ) {\n\t\tprng = base;\n\t\trand = uniform2;\n\t} else if ( nargs === 1 ) {\n\t\toptions = arguments[ 0 ];\n\t\tprng = base.factory( options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform2;\n\t} else if ( nargs === 2 ) {\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ] );\n\t\trand = uniform1;\n\t} else if ( nargs === 3 ) {\n\t\toptions = arguments[ 2 ];\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ], options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform1;\n\t}\n\tif ( options && options.prng ) {\n\t\tsetReadOnly( rand, 'seed', null );\n\t\tsetReadOnly( rand, 'seedLength', null );\n\t\tsetReadWriteAccessor( rand, 'state', constantFunction( null ), noop );\n\t\tsetReadOnly( rand, 'stateLength', null );\n\t\tsetReadOnly( rand, 'byteLength', null );\n\t} else {\n\t\tsetReadOnlyAccessor( rand, 'seed', getSeed );\n\t\tsetReadOnlyAccessor( rand, 'seedLength', getSeedLength );\n\t\tsetReadWriteAccessor( rand, 'state', getState, setState );\n\t\tsetReadOnlyAccessor( rand, 'stateLength', getStateLength );\n\t\tsetReadOnlyAccessor( rand, 'byteLength', getStateSize );\n\t}\n\tsetReadOnly( rand, 'PRNG', prng.PRNG );\n\treturn rand;\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform1( len, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( '1eR2d,MG', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 1 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, prng );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tnullary( [ out ], [ len ], [ 1 ], prng );\n\t\treturn out;\n\t}\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {number} a - minimum support\n\t* @param {number} b - maximum support\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform2( len, a, b, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( '1eR2d,MG', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 3 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\t// NOTE: we could alternatively use the PRNG factory function to create a PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. Decision made here to avoid this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom number. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in a return value of `NaN`.\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, wrapper );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tbinary( [ [ a ], [ b ], out ], [ len ], [ 0, 0, 1 ], prng );\n\t\treturn out;\n\n\t\t/**\n\t\t* Applies parameters to a pseudorandom number generator function.\n\t\t*\n\t\t* @private\n\t\t* @returns {number} pseudorandom number\n\t\t*/\n\t\tfunction wrapper() {\n\t\t\treturn prng( a, b );\n\t\t}\n\t}\n\n\t/**\n\t* Returns the PRNG seed.\n\t*\n\t* @private\n\t* @returns {PRNGSeedMT19937} seed\n\t*/\n\tfunction getSeed() {\n\t\treturn rand.PRNG.seed;\n\t}\n\n\t/**\n\t* Returns the PRNG seed length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} seed length\n\t*/\n\tfunction getSeedLength() {\n\t\treturn rand.PRNG.seedLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state length\n\t*/\n\tfunction getStateLength() {\n\t\treturn rand.PRNG.stateLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state size (in bytes).\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state size (in bytes)\n\t*/\n\tfunction getStateSize() {\n\t\treturn rand.PRNG.byteLength;\n\t}\n\n\t/**\n\t* Returns the current pseudorandom number generator state.\n\t*\n\t* @private\n\t* @returns {PRNGStateMT19937} current state\n\t*/\n\tfunction getState() {\n\t\treturn rand.PRNG.state;\n\t}\n\n\t/**\n\t* Sets the pseudorandom number generator state.\n\t*\n\t* @private\n\t* @param {PRNGStateMT19937} s - generator state\n\t* @throws {Error} must provide a valid state\n\t*/\n\tfunction setState( s ) {\n\t\trand.PRNG.state = s;\n\t}\n}\n\n\n// EXPORTS //\n\nexport default factory;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @name uniform\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\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 = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar uniform = factory();\n\n\n// EXPORTS //\n\nexport default uniform;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @module @stdlib/random-array-uniform\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.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\" }\n"],"names":["DTYPES","dtypes","validate","opts","options","isObject","hasOwnProp","dtype","indexOf","TypeError","format","join","factory","nargs","rand","prng","err","defaults","arguments","length","base","uniform2","uniform1","setReadOnly","setReadWriteAccessor","constantFunction","noop","setReadOnlyAccessor","getSeed","getSeedLength","getState","setState","getStateLength","getStateSize","PRNG","len","out","dt","o","isNonNegativeInteger","filledBy","ctors","nullary","a","b","wrapper","binary","seed","seedLength","stateLength","byteLength","state","s","push","uniform","main"],"mappings":";;ohDA8BIA,EAASC,IAyBb,SAASC,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,WACzBD,EAAKI,MAAQH,EAAQG,MAChBP,EAAOQ,QAASL,EAAKI,OAAU,GAC5B,IAAIE,UAAWC,EAAQ,uBAAwB,QAASV,EAAOW,KAAM,QAAUR,EAAKI,QAGtF,KARC,IAAIE,UAAWC,EAAQ,WAAYN,GAS5C,CCSA,SAASQ,IACR,IAAIR,EACAS,EACAV,EACAW,EACAC,EACAC,EAOJ,GALAb,EAAO,CACNI,MAASU,GAIK,KADfJ,EAAQK,UAAUC,QAEjBJ,EAAOK,EACPN,EAAOO,OACD,GAAe,IAAVR,EAAc,CAIzB,GAHAT,EAAUc,UAAW,GACrBH,EAAOK,EAAKR,QAASR,GACrBY,EAAMd,EAAUC,EAAMC,GAErB,MAAMY,EAEPF,EAAOO,CACT,MAAQ,GAAe,IAAVR,EACXE,EAAOK,EAAKR,QAASM,UAAW,GAAKA,UAAW,IAChDJ,EAAOQ,OACD,GAAe,IAAVT,EAAc,CAIzB,GAHAT,EAAUc,UAAW,GACrBH,EAAOK,EAAKR,QAASM,UAAW,GAAKA,UAAW,GAAKd,GACrDY,EAAMd,EAAUC,EAAMC,GAErB,MAAMY,EAEPF,EAAOQ,CACP,CAeD,OAdKlB,GAAWA,EAAQW,MACvBQ,EAAaT,EAAM,OAAQ,MAC3BS,EAAaT,EAAM,aAAc,MACjCU,EAAsBV,EAAM,QAASW,EAAkB,MAAQC,GAC/DH,EAAaT,EAAM,cAAe,MAClCS,EAAaT,EAAM,aAAc,QAEjCa,EAAqBb,EAAM,OAAQc,GACnCD,EAAqBb,EAAM,aAAce,GACzCL,EAAsBV,EAAM,QAASgB,EAAUC,GAC/CJ,EAAqBb,EAAM,cAAekB,GAC1CL,EAAqBb,EAAM,aAAcmB,IAE1CV,EAAaT,EAAM,OAAQC,EAAKmB,MACzBpB,EAcP,SAASQ,EAAUa,EAAK/B,GACvB,IACIgC,EACApB,EACAqB,EACAC,EACJ,IAAMC,EAAsBJ,GAC3B,MAAM,IAAI1B,UAAWC,EAAQ,WAAYyB,IAG1C,GADAG,EAAI,CAAA,EACCpB,UAAUC,OAAS,IACvBH,EAAMd,EAAUoC,EAAGlC,IAElB,MAAMY,EAIR,MAAY,aADZqB,EAAKC,EAAE/B,OAASJ,EAAKI,OAEbiC,EAAUL,EAAKpB,IAGvBqB,EAAM,IADCK,EAAOJ,GACR,CAAUF,GAChBO,EAAS,CAAEN,GAAO,CAAED,GAAO,CAAE,GAAKpB,GAC3BqB,EACP,CAgBD,SAASf,EAAUc,EAAKQ,EAAGC,EAAGxC,GAC7B,IACIgC,EACApB,EACAqB,EACAC,EACJ,IAAMC,EAAsBJ,GAC3B,MAAM,IAAI1B,UAAWC,EAAQ,WAAYyB,IAG1C,GADAG,EAAI,CAAA,EACCpB,UAAUC,OAAS,IACvBH,EAAMd,EAAUoC,EAAGlC,IAElB,MAAMY,EAKR,MAAY,aADZqB,EAAKC,EAAE/B,OAASJ,EAAKI,OAEbiC,EAAUL,EAAKU,IAGvBT,EAAM,IADCK,EAAOJ,GACR,CAAUF,GAChBW,EAAQ,CAAE,CAAEH,GAAK,CAAEC,GAAKR,GAAO,CAAED,GAAO,CAAE,EAAG,EAAG,GAAKpB,GAC9CqB,GAQP,SAASS,IACR,OAAO9B,EAAM4B,EAAGC,EAChB,CACD,CAQD,SAAShB,IACR,OAAOd,EAAKoB,KAAKa,IACjB,CAQD,SAASlB,IACR,OAAOf,EAAKoB,KAAKc,UACjB,CAQD,SAAShB,IACR,OAAOlB,EAAKoB,KAAKe,WACjB,CAQD,SAAShB,IACR,OAAOnB,EAAKoB,KAAKgB,UACjB,CAQD,SAASpB,IACR,OAAOhB,EAAKoB,KAAKiB,KACjB,CASD,SAASpB,EAAUqB,GAClBtC,EAAKoB,KAAKiB,MAAQC,CAClB,CACF,CDrPApD,EAAOqD,KAAM,WEqBV,IAACC,EAAU1C,ICiBdW,EAAAgC,EAAA,UAAA3C"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 3e4c148..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From bd1bdbaa00f0a34fcb86848e16b153b4e6dc2ed7 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 7 Oct 2023 20:39:52 +0000 Subject: [PATCH 36/82] Auto-generated commit --- .editorconfig | 186 - .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 | 247 - .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 | 227 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 61 +- benchmark/benchmark.float32.factory.js | 96 - benchmark/benchmark.float32.js | 98 - benchmark/benchmark.float64.factory.js | 96 - benchmark/benchmark.float64.js | 98 - benchmark/benchmark.generic.factory.js | 96 - benchmark/benchmark.generic.js | 98 - branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 9 - dist/index.js.map | 7 - docs/repl.txt | 169 - docs/types/test.ts | 355 -- examples/index.js | 48 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/defaults.json | 3 - lib/factory.js | 282 - lib/index.js | 77 - lib/main.js | 58 - lib/validate.js | 72 - package.json | 76 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 69 - test/test.factory.js | 1328 ----- test/test.js | 69 - test/test.main.js | 244 - test/test.validate.js | 118 - 52 files changed, 6215 insertions(+), 6811 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 benchmark/benchmark.float32.factory.js delete mode 100644 benchmark/benchmark.float32.js delete mode 100644 benchmark/benchmark.float64.factory.js delete mode 100644 benchmark/benchmark.float64.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/defaults.json delete mode 100644 lib/factory.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.factory.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js delete mode 100644 test/test.validate.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 13e9c39..0000000 --- a/.editorconfig +++ /dev/null @@ -1,186 +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 `tslint.json` files: -[tslint.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 c4ab52b..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/uniform) 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 ab56cca..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 corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # 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: 16 - 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 5097056..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/uniform) 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 c1c45e7..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 corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # 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: 16 - 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 bd8d245..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: '33 9 * * 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 corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - 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: 16 - 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 corresponding to v3.0.3: - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 - 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 265afda..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 corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - 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: 16 - 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 corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - 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: 16 - 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 corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # 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: 16 - 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 corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # 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: 16 - 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 + + ```
@@ -375,7 +374,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]. @@ -435,13 +434,13 @@ Copyright © 2016-2023. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/random-array-uniform/main/LICENSE -[@stdlib/random/base/uniform]: https://github.com/stdlib-js/random-base-uniform +[@stdlib/random/base/uniform]: https://github.com/stdlib-js/random-base-uniform/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/benchmark/benchmark.float32.factory.js b/benchmark/benchmark.float32.factory.js deleted file mode 100644 index 67e61f4..0000000 --- a/benchmark/benchmark.float32.factory.js +++ /dev/null @@ -1,96 +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 bench = require( '@stdlib/bench' ); -var isnanf = require( '@stdlib/math-base-assert-is-nanf' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var fcn = uniform.factory( 2.0, 5.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 4642816..0000000 --- a/benchmark/benchmark.float32.js +++ /dev/null @@ -1,98 +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 bench = require( '@stdlib/bench' ); -var isnanf = require( '@stdlib/math-base-assert-is-nanf' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = 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 = uniform( len, 2.0, 5.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.factory.js b/benchmark/benchmark.float64.factory.js deleted file mode 100644 index 8646a54..0000000 --- a/benchmark/benchmark.float64.factory.js +++ /dev/null @@ -1,96 +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 bench = require( '@stdlib/bench' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var fcn = uniform.factory( 2.0, 5.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 5ee0d97..0000000 --- a/benchmark/benchmark.float64.js +++ /dev/null @@ -1,98 +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 bench = require( '@stdlib/bench' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = 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 = uniform( len, 2.0, 5.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.factory.js b/benchmark/benchmark.generic.factory.js deleted file mode 100644 index 7020d62..0000000 --- a/benchmark/benchmark.generic.factory.js +++ /dev/null @@ -1,96 +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 bench = require( '@stdlib/bench' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var fcn = uniform.factory( 2.0, 5.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 06a2a83..0000000 --- a/benchmark/benchmark.generic.js +++ /dev/null @@ -1,98 +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 bench = require( '@stdlib/bench' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = 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 = uniform( len, 2.0, 5.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 30542fb..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/uniform" -%% click B href "https://github.com/stdlib-js/random-array-uniform/tree/main" -%% click C href "https://github.com/stdlib-js/random-array-uniform/tree/production" -%% click D href "https://github.com/stdlib-js/random-array-uniform/tree/esm" -%% click E href "https://github.com/stdlib-js/random-array-uniform/tree/deno" -%% click F href "https://github.com/stdlib-js/random-array-uniform/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/uniform -[production-url]: https://github.com/stdlib-js/random-array-uniform/tree/production -[deno-url]: https://github.com/stdlib-js/random-array-uniform/tree/deno -[umd-url]: https://github.com/stdlib-js/random-array-uniform/tree/umd -[esm-url]: https://github.com/stdlib-js/random-array-uniform/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 f2a679f..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import uniform from '../docs/types/index'; -export = uniform; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 0ef1443..0000000 --- a/dist/index.js +++ /dev/null @@ -1,9 +0,0 @@ -"use strict";var y=function(t,r){return function(){return r||t((r={exports:{}}).exports,r),r.exports}};var b=y(function(ue,H){H.exports={dtype:"float64"}});var O=y(function(se,G){ -var J=require('@stdlib/array-typed-real-float-dtypes/dist'),K=require('@stdlib/assert-is-plain-object/dist'),M=require('@stdlib/assert-has-own-property/dist'),N=require('@stdlib/error-tools-fmtprodmsg/dist'),w=J();w.push("generic");function Q(t,r){return K(r)?M(r,"dtype")&&(t.dtype=r.dtype,w.indexOf(t.dtype)<0)?new TypeError(N('1eR4S',"dtype",w.join('", "'),t.dtype)):null:new TypeError(N('1eR2V',r));}G.exports=Q -});var R=y(function(oe,F){ -var S=require('@stdlib/assert-is-nonnegative-integer/dist').isPrimitive,d=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),l=require('@stdlib/utils-define-nonenumerable-read-only-accessor/dist'),x=require('@stdlib/utils-define-nonenumerable-read-write-accessor/dist'),U=require('@stdlib/utils-constant-function/dist'),X=require('@stdlib/utils-noop/dist'),p=require('@stdlib/random-base-uniform/dist'),E=require('@stdlib/array-typed-real-float-ctors/dist'),T=require('@stdlib/array-base-filled-by/dist'),Z=require('@stdlib/strided-base-nullary/dist'),_=require('@stdlib/strided-base-binary/dist'),j=require('@stdlib/error-tools-fmtprodmsg/dist'),$=b(),m=O();function ee(){var t,r,v,e,a,s;if(v={dtype:$.dtype},r=arguments.length,r===0)a=p,e=P;else if(r===1){if(t=arguments[0],a=p.factory(t),s=m(v,t),s)throw s;e=P}else if(r===2)a=p.factory(arguments[0],arguments[1]),e=L;else if(r===3){if(t=arguments[2],a=p.factory(arguments[0],arguments[1],t),s=m(v,t),s)throw s;e=L}return t&&t.prng?(d(e,"seed",null),d(e,"seedLength",null),x(e,"state",U(null),X),d(e,"stateLength",null),d(e,"byteLength",null)):(l(e,"seed",B),l(e,"seedLength",D),x(e,"state",Y,k),l(e,"stateLength",I),l(e,"byteLength",W)),d(e,"PRNG",a.PRNG),e;function L(n,c){var f,g,o,i,u;if(!S(n))throw new TypeError(j('1eR2d',n));if(u={},arguments.length>1&&(o=m(u,c),o))throw o;return i=u.dtype||v.dtype,i==="generic"?T(n,a):(f=E(i),g=new f(n),Z([g],[n],[1],a),g)}function P(n,c,f,g){var o,i,u,h,q;if(!S(n))throw new TypeError(j('1eR2d',n));if(q={},arguments.length>3&&(u=m(q,g),u))throw u;if(h=q.dtype||v.dtype,h==="generic")return T(n,C);return o=E(h),i=new o(n),_([[c],[f],i],[n],[0,0,1],a),i;function C(){return a(c,f)}}function B(){return e.PRNG.seed}function D(){return e.PRNG.seedLength}function I(){return e.PRNG.stateLength}function W(){return e.PRNG.byteLength}function Y(){return e.PRNG.state}function k(n){e.PRNG.state=n}}F.exports=ee -});var A=y(function(ve,V){ -var re=R(),te=re();V.exports=te -});var ne=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),z=A(),ae=R();ne(z,"factory",ae);module.exports=z; -/** @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 fcb8851..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/defaults.json", "../lib/validate.js", "../lib/factory.js", "../lib/main.js", "../lib/index.js"], - "sourcesContent": ["{\n\t\"dtype\": \"float64\"\n}\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 dtypes = require( '@stdlib/array-typed-real-float-dtypes' );\nvar isObject = require( '@stdlib/assert-is-plain-object' );\nvar hasOwnProp = require( '@stdlib/assert-has-own-property' );\nvar format = require( '@stdlib/string-format' );\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes();\nDTYPES.push( 'generic' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( DTYPES.indexOf( opts.dtype ) < 0 ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be one of the following: \"%s\". Option: `%s`.', 'dtype', DTYPES.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nmodule.exports = validate;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive;\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar setReadOnlyAccessor = require( '@stdlib/utils-define-nonenumerable-read-only-accessor' );\nvar setReadWriteAccessor = require( '@stdlib/utils-define-nonenumerable-read-write-accessor' );\nvar constantFunction = require( '@stdlib/utils-constant-function' );\nvar noop = require( '@stdlib/utils-noop' );\nvar base = require( '@stdlib/random-base-uniform' );\nvar ctors = require( '@stdlib/array-typed-real-float-ctors' );\nvar filledBy = require( '@stdlib/array-base-filled-by' );\nvar nullary = require( '@stdlib/strided-base-nullary' );\nvar binary = require( '@stdlib/strided-base-binary' );\nvar format = require( '@stdlib/string-format' );\nvar defaults = require( './defaults.json' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution.\n*\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\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 {RangeError} `a` must be less than `b`\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 uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10 );\n* // returns \n*\n* @example\n* var uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nfunction factory() {\n\tvar options;\n\tvar nargs;\n\tvar opts;\n\tvar rand;\n\tvar prng;\n\tvar err;\n\n\topts = {\n\t\t'dtype': defaults.dtype\n\t};\n\n\tnargs = arguments.length;\n\tif ( nargs === 0 ) {\n\t\tprng = base;\n\t\trand = uniform2;\n\t} else if ( nargs === 1 ) {\n\t\toptions = arguments[ 0 ];\n\t\tprng = base.factory( options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform2;\n\t} else if ( nargs === 2 ) {\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ] );\n\t\trand = uniform1;\n\t} else if ( nargs === 3 ) {\n\t\toptions = arguments[ 2 ];\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ], options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform1;\n\t}\n\tif ( options && options.prng ) {\n\t\tsetReadOnly( rand, 'seed', null );\n\t\tsetReadOnly( rand, 'seedLength', null );\n\t\tsetReadWriteAccessor( rand, 'state', constantFunction( null ), noop );\n\t\tsetReadOnly( rand, 'stateLength', null );\n\t\tsetReadOnly( rand, 'byteLength', null );\n\t} else {\n\t\tsetReadOnlyAccessor( rand, 'seed', getSeed );\n\t\tsetReadOnlyAccessor( rand, 'seedLength', getSeedLength );\n\t\tsetReadWriteAccessor( rand, 'state', getState, setState );\n\t\tsetReadOnlyAccessor( rand, 'stateLength', getStateLength );\n\t\tsetReadOnlyAccessor( rand, 'byteLength', getStateSize );\n\t}\n\tsetReadOnly( rand, 'PRNG', prng.PRNG );\n\treturn rand;\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform1( len, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 1 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, prng );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tnullary( [ out ], [ len ], [ 1 ], prng );\n\t\treturn out;\n\t}\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {number} a - minimum support\n\t* @param {number} b - maximum support\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform2( len, a, b, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 3 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\t// NOTE: we could alternatively use the PRNG factory function to create a PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. Decision made here to avoid this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom number. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in a return value of `NaN`.\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, wrapper );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tbinary( [ [ a ], [ b ], out ], [ len ], [ 0, 0, 1 ], prng );\n\t\treturn out;\n\n\t\t/**\n\t\t* Applies parameters to a pseudorandom number generator function.\n\t\t*\n\t\t* @private\n\t\t* @returns {number} pseudorandom number\n\t\t*/\n\t\tfunction wrapper() {\n\t\t\treturn prng( a, b );\n\t\t}\n\t}\n\n\t/**\n\t* Returns the PRNG seed.\n\t*\n\t* @private\n\t* @returns {PRNGSeedMT19937} seed\n\t*/\n\tfunction getSeed() {\n\t\treturn rand.PRNG.seed;\n\t}\n\n\t/**\n\t* Returns the PRNG seed length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} seed length\n\t*/\n\tfunction getSeedLength() {\n\t\treturn rand.PRNG.seedLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state length\n\t*/\n\tfunction getStateLength() {\n\t\treturn rand.PRNG.stateLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state size (in bytes).\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state size (in bytes)\n\t*/\n\tfunction getStateSize() {\n\t\treturn rand.PRNG.byteLength;\n\t}\n\n\t/**\n\t* Returns the current pseudorandom number generator state.\n\t*\n\t* @private\n\t* @returns {PRNGStateMT19937} current state\n\t*/\n\tfunction getState() {\n\t\treturn rand.PRNG.state;\n\t}\n\n\t/**\n\t* Sets the pseudorandom number generator state.\n\t*\n\t* @private\n\t* @param {PRNGStateMT19937} s - generator state\n\t* @throws {Error} must provide a valid state\n\t*/\n\tfunction setState( s ) {\n\t\trand.PRNG.state = s;\n\t}\n}\n\n\n// EXPORTS //\n\nmodule.exports = factory;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @name uniform\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\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 = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar uniform = factory();\n\n\n// EXPORTS //\n\nmodule.exports = uniform;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @module @stdlib/random-array-uniform\n*\n* @example\n* var uniform = require( '@stdlib/random-array-uniform' );\n*\n* var arr = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var uniform = require( '@stdlib/random-array-uniform' );\n*\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* var uniform = require( '@stdlib/random-array-uniform' );\n*\n* var rand = uniform.factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* var uniform = require( '@stdlib/random-array-uniform' );\n*\n* var rand = uniform.factory( 2.0, 5.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\" }\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,GAAAC,EAAA,CAAAA,EAAA,SACC,MAAS,SACV,ICFA,IAAAC,EAAAC,EAAA,SAAAC,GAAAC,EAAA,cAsBA,IAAIC,EAAS,QAAS,uCAAwC,EAC1DC,EAAW,QAAS,gCAAiC,EACrDC,EAAa,QAAS,iCAAkC,EACxDC,EAAS,QAAS,uBAAwB,EAK1CC,EAASJ,EAAO,EACpBI,EAAO,KAAM,SAAU,EAwBvB,SAASC,EAAUC,EAAMC,EAAU,CAClC,OAAMN,EAAUM,CAAQ,EAGnBL,EAAYK,EAAS,OAAQ,IACjCD,EAAK,MAAQC,EAAQ,MAChBH,EAAO,QAASE,EAAK,KAAM,EAAI,GAC5B,IAAI,UAAWH,EAAQ,gFAAiF,QAASC,EAAO,KAAM,MAAO,EAAGE,EAAK,KAAM,CAAE,EAGvJ,KARC,IAAI,UAAWH,EAAQ,qEAAsEI,CAAQ,CAAE,CAShH,CAKAR,EAAO,QAAUM,ICvEjB,IAAAG,EAAAC,EAAA,SAAAC,GAAAC,EAAA,cAsBA,IAAIC,EAAuB,QAAS,uCAAwC,EAAE,YAC1EC,EAAc,QAAS,uDAAwD,EAC/EC,EAAsB,QAAS,uDAAwD,EACvFC,EAAuB,QAAS,wDAAyD,EACzFC,EAAmB,QAAS,iCAAkC,EAC9DC,EAAO,QAAS,oBAAqB,EACrCC,EAAO,QAAS,6BAA8B,EAC9CC,EAAQ,QAAS,sCAAuC,EACxDC,EAAW,QAAS,8BAA+B,EACnDC,EAAU,QAAS,8BAA+B,EAClDC,EAAS,QAAS,6BAA8B,EAChDC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IACXC,EAAW,IAwCf,SAASC,IAAU,CAClB,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EAOJ,GALAH,EAAO,CACN,MAASL,EAAS,KACnB,EAEAI,EAAQ,UAAU,OACbA,IAAU,EACdG,EAAOb,EACPY,EAAOG,UACIL,IAAU,EAAI,CAIzB,GAHAD,EAAU,UAAW,CAAE,EACvBI,EAAOb,EAAK,QAASS,CAAQ,EAC7BK,EAAMP,EAAUI,EAAMF,CAAQ,EACzBK,EACJ,MAAMA,EAEPF,EAAOG,CACR,SAAYL,IAAU,EACrBG,EAAOb,EAAK,QAAS,UAAW,CAAE,EAAG,UAAW,CAAE,CAAE,EACpDY,EAAOI,UACIN,IAAU,EAAI,CAIzB,GAHAD,EAAU,UAAW,CAAE,EACvBI,EAAOb,EAAK,QAAS,UAAW,CAAE,EAAG,UAAW,CAAE,EAAGS,CAAQ,EAC7DK,EAAMP,EAAUI,EAAMF,CAAQ,EACzBK,EACJ,MAAMA,EAEPF,EAAOI,CACR,CACA,OAAKP,GAAWA,EAAQ,MACvBd,EAAaiB,EAAM,OAAQ,IAAK,EAChCjB,EAAaiB,EAAM,aAAc,IAAK,EACtCf,EAAsBe,EAAM,QAASd,EAAkB,IAAK,EAAGC,CAAK,EACpEJ,EAAaiB,EAAM,cAAe,IAAK,EACvCjB,EAAaiB,EAAM,aAAc,IAAK,IAEtChB,EAAqBgB,EAAM,OAAQK,CAAQ,EAC3CrB,EAAqBgB,EAAM,aAAcM,CAAc,EACvDrB,EAAsBe,EAAM,QAASO,EAAUC,CAAS,EACxDxB,EAAqBgB,EAAM,cAAeS,CAAe,EACzDzB,EAAqBgB,EAAM,aAAcU,CAAa,GAEvD3B,EAAaiB,EAAM,OAAQC,EAAK,IAAK,EAC9BD,EAcP,SAASI,EAAUO,EAAKd,EAAU,CACjC,IAAIe,EACAC,EACAX,EACAY,EACAC,EACJ,GAAK,CAACjC,EAAsB6B,CAAI,EAC/B,MAAM,IAAI,UAAWlB,EAAQ,+EAAgFkB,CAAI,CAAE,EAGpH,GADAI,EAAI,CAAC,EACA,UAAU,OAAS,IACvBb,EAAMP,EAAUoB,EAAGlB,CAAQ,EACtBK,GACJ,MAAMA,EAIR,OADAY,EAAKC,EAAE,OAAShB,EAAK,MAChBe,IAAO,UACJxB,EAAUqB,EAAKV,CAAK,GAE5BW,EAAOvB,EAAOyB,CAAG,EACjBD,EAAM,IAAID,EAAMD,CAAI,EACpBpB,EAAS,CAAEsB,CAAI,EAAG,CAAEF,CAAI,EAAG,CAAE,CAAE,EAAGV,CAAK,EAChCY,EACR,CAgBA,SAASV,EAAUQ,EAAKK,EAAGC,EAAGpB,EAAU,CACvC,IAAIe,EACAC,EACAX,EACAY,EACAC,EACJ,GAAK,CAACjC,EAAsB6B,CAAI,EAC/B,MAAM,IAAI,UAAWlB,EAAQ,+EAAgFkB,CAAI,CAAE,EAGpH,GADAI,EAAI,CAAC,EACA,UAAU,OAAS,IACvBb,EAAMP,EAAUoB,EAAGlB,CAAQ,EACtBK,GACJ,MAAMA,EAKR,GADAY,EAAKC,EAAE,OAAShB,EAAK,MAChBe,IAAO,UACX,OAAOxB,EAAUqB,EAAKO,CAAQ,EAE/B,OAAAN,EAAOvB,EAAOyB,CAAG,EACjBD,EAAM,IAAID,EAAMD,CAAI,EACpBnB,EAAQ,CAAE,CAAEwB,CAAE,EAAG,CAAEC,CAAE,EAAGJ,CAAI,EAAG,CAAEF,CAAI,EAAG,CAAE,EAAG,EAAG,CAAE,EAAGV,CAAK,EACnDY,EAQP,SAASK,GAAU,CAClB,OAAOjB,EAAMe,EAAGC,CAAE,CACnB,CACD,CAQA,SAASZ,GAAU,CAClB,OAAOL,EAAK,KAAK,IAClB,CAQA,SAASM,GAAgB,CACxB,OAAON,EAAK,KAAK,UAClB,CAQA,SAASS,GAAiB,CACzB,OAAOT,EAAK,KAAK,WAClB,CAQA,SAASU,GAAe,CACvB,OAAOV,EAAK,KAAK,UAClB,CAQA,SAASO,GAAW,CACnB,OAAOP,EAAK,KAAK,KAClB,CASA,SAASQ,EAAUW,EAAI,CACtBnB,EAAK,KAAK,MAAQmB,CACnB,CACD,CAKAtC,EAAO,QAAUe,KCzRjB,IAAAwB,EAAAC,EAAA,SAAAC,GAAAC,EAAA,cAsBA,IAAIC,GAAU,IA8BVC,GAAUD,GAAQ,EAKtBD,EAAO,QAAUE,KCKjB,IAAIC,GAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,GAAU,IAKdF,GAAaC,EAAM,UAAWC,EAAQ,EAKtC,OAAO,QAAUD", - "names": ["require_defaults", "__commonJSMin", "exports", "module", "require_validate", "__commonJSMin", "exports", "module", "dtypes", "isObject", "hasOwnProp", "format", "DTYPES", "validate", "opts", "options", "require_factory", "__commonJSMin", "exports", "module", "isNonNegativeInteger", "setReadOnly", "setReadOnlyAccessor", "setReadWriteAccessor", "constantFunction", "noop", "base", "ctors", "filledBy", "nullary", "binary", "format", "defaults", "validate", "factory", "options", "nargs", "opts", "rand", "prng", "err", "uniform2", "uniform1", "getSeed", "getSeedLength", "getState", "setState", "getStateLength", "getStateSize", "len", "ctor", "out", "dt", "o", "a", "b", "wrapper", "s", "require_main", "__commonJSMin", "exports", "module", "factory", "uniform", "setReadOnly", "main", "factory"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 256216a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,169 +0,0 @@ - -{{alias}}( len, a, b[, options] ) - Returns an array containing pseudorandom numbers drawn from a continuous - uniform distribution. - - Parameters - ---------- - len: integer - Output array length. - - a: number - Minimum support. - - b: number - Maximum support. - - 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 ) - - - -{{alias}}.factory( [a, b, ][options] ) - Returns a function for creating arrays containing pseudorandom numbers drawn - from a continuous uniform distribution. - - If provided `a` and `b`, the returned function returns random variates drawn - from the specified distribution. - - If not provided `a` and `b`, the returned function requires that both `a` - and `b` 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. - - 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 ) - - - // Provide distribution parameters: - > fcn = {{alias}}.factory( 2.0, 5.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 ) - - - // Get a copy of the current state: - > var state = {{alias}}.state - - - > out = {{alias}}( 3, 2.0, 5.0 ) - - > out = {{alias}}( 3, 2.0, 5.0 ) - - - // Set the state: - > {{alias}}.state = state; - - // Regenerate a previous array: - > out = {{alias}}( 3, 2.0, 5.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 a087b98..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,355 +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. -*/ - -import random = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - random( 10, 2, 3 ); // $ExpectType RandomArray - random( 10, 1, 2 ); // $ExpectType RandomArray - random( 10, 1, 2, {} ); // $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 ); // $ExpectError - random( true, 2.0, 5.0 ); // $ExpectError - random( false, 2.0, 5.0 ); // $ExpectError - random( null, 2.0, 5.0 ); // $ExpectError - random( [], 2.0, 5.0 ); // $ExpectError - random( {}, 2.0, 5.0 ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - random( '5', 2.0, 5.0, {} ); // $ExpectError - random( true, 2.0, 5.0, {} ); // $ExpectError - random( false, 2.0, 5.0, {} ); // $ExpectError - random( null, 2.0, 5.0, {} ); // $ExpectError - random( [], 2.0, 5.0, {} ); // $ExpectError - random( {}, 2.0, 5.0, {} ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.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 ); // $ExpectError - random( 10, true, 5.0 ); // $ExpectError - random( 10, false, 5.0 ); // $ExpectError - random( 10, null, 5.0 ); // $ExpectError - random( 10, [], 5.0 ); // $ExpectError - random( 10, {}, 5.0 ); // $ExpectError - random( 10, ( x: number ): number => x, 5.0 ); // $ExpectError - - random( 10, '5', 5.0, {} ); // $ExpectError - random( 10, true, 5.0, {} ); // $ExpectError - random( 10, false, 5.0, {} ); // $ExpectError - random( 10, null, 5.0, {} ); // $ExpectError - random( 10, [], 5.0, {} ); // $ExpectError - random( 10, {}, 5.0, {} ); // $ExpectError - random( 10, ( x: number ): number => x, 5.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' ); // $ExpectError - random( 10, 2.0, true ); // $ExpectError - random( 10, 2.0, false ); // $ExpectError - random( 10, 2.0, null ); // $ExpectError - random( 10, 2.0, [] ); // $ExpectError - random( 10, 2.0, {} ); // $ExpectError - random( 10, 2.0, ( x: number ): number => x ); // $ExpectError - - random( 10, 2.0, '5', {} ); // $ExpectError - random( 10, 2.0, true, {} ); // $ExpectError - random( 10, 2.0, false, {} ); // $ExpectError - random( 10, 2.0, null, {} ); // $ExpectError - random( 10, 2.0, [], {} ); // $ExpectError - random( 10, 2.0, {}, {} ); // $ExpectError - random( 10, 2.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, '5' ); // $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, [] ); // $ExpectError - random( 10, 2.0, 5.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, { 'dtype': 123 } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': null } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - random( 10, 2.0, 5.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 -} - -// Attached to main export is a `factory` method which returns a function... -{ - random.factory( 2.0, 5.0 ); // $ExpectType UnaryFunction - random.factory( 2.0, 5.0, { 'copy': false } ); // $ExpectType UnaryFunction - - random.factory(); // $ExpectType TernaryFunction - random.factory( { 'copy': false } ); // $ExpectType TernaryFunction -} - -// The `factory` method returns a function which returns an array... -{ - const fcn1 = random.factory( 2.0, 5.0 ); - fcn1( 10 ); // $ExpectType RandomArray - - const fcn2 = random.factory(); - fcn2( 10, 2.0, 5.0 ); // $ExpectType RandomArray -} - -// The compiler throws an error if the `factory` method is provided invalid arguments... -{ - random.factory( '5', 5.0 ); // $ExpectError - random.factory( true, 5.0 ); // $ExpectError - random.factory( false, 5.0 ); // $ExpectError - random.factory( [], 5.0 ); // $ExpectError - random.factory( {}, 5.0 ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0 ); // $ExpectError - - random.factory( '5', 5.0, {} ); // $ExpectError - random.factory( true, 5.0, {} ); // $ExpectError - random.factory( false, 5.0, {} ); // $ExpectError - random.factory( [], 5.0, {} ); // $ExpectError - random.factory( {}, 5.0, {} ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0, {} ); // $ExpectError - - random.factory( 2.0, '5' ); // $ExpectError - random.factory( 2.0, true ); // $ExpectError - random.factory( 2.0, false ); // $ExpectError - random.factory( 2.0, [] ); // $ExpectError - random.factory( 2.0, {} ); // $ExpectError - random.factory( 2.0, ( x: number ): number => x ); // $ExpectError - - random.factory( 2.0, '5', {} ); // $ExpectError - random.factory( 2.0, true, {} ); // $ExpectError - random.factory( 2.0, false, {} ); // $ExpectError - random.factory( 2.0, [], {} ); // $ExpectError - random.factory( 2.0, {}, {} ); // $ExpectError - random.factory( 2.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, 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, { 'prng': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'seed': true } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': [ 'a' ] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'state': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': {} } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': true ); // $ExpectError - random.factory( 2.0, 5.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, { 'copy': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'dtype': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - random.factory( 2.0, 5.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, {}, {} ); // $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 ); - 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 ); // $ExpectError - fcn2( false, 2.0, 5.0 ); // $ExpectError - fcn2( '5', 2.0, 5.0 ); // $ExpectError - fcn2( [], 2.0, 5.0 ); // $ExpectError - fcn2( {}, 2.0, 5.0 ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - fcn2( true, 2.0, 5.0, {} ); // $ExpectError - fcn2( false, 2.0, 5.0, {} ); // $ExpectError - fcn2( '5', 2.0, 5.0, {} ); // $ExpectError - fcn2( [], 2.0, 5.0, {} ); // $ExpectError - fcn2( {}, 2.0, 5.0, {} ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0, {} ); // $ExpectError - - fcn2( 10, true, 5.0 ); // $ExpectError - fcn2( 10, false, 5.0 ); // $ExpectError - fcn2( 10, '5', 5.0 ); // $ExpectError - fcn2( 10, [], 5.0 ); // $ExpectError - fcn2( 10, {}, 5.0 ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0 ); // $ExpectError - - fcn2( 10, true, 5.0, {} ); // $ExpectError - fcn2( 10, false, 5.0, {} ); // $ExpectError - fcn2( 10, '5', 5.0, {} ); // $ExpectError - fcn2( 10, [], 5.0, {} ); // $ExpectError - fcn2( 10, {}, 5.0, {} ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0, {} ); // $ExpectError - - fcn2( 10, 2.0, true ); // $ExpectError - fcn2( 10, 2.0, false ); // $ExpectError - fcn2( 10, 2.0, '5' ); // $ExpectError - fcn2( 10, 2.0, [] ); // $ExpectError - fcn2( 10, 2.0, {} ); // $ExpectError - fcn2( 10, 2.0, ( x: number ): number => x ); // $ExpectError - - fcn2( 10, 2.0, true, {} ); // $ExpectError - fcn2( 10, 2.0, false, {} ); // $ExpectError - fcn2( 10, 2.0, '5', {} ); // $ExpectError - fcn2( 10, 2.0, [], {} ); // $ExpectError - fcn2( 10, 2.0, {}, {} ); // $ExpectError - fcn2( 10, 2.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, { 'dtype': 123 } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': null } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError - - const fcn2 = random.factory( 2.0, 5.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 ); - fcn1(); // $ExpectError - fcn1( 1, 1, 1 ); // $ExpectError - - const fcn2 = random.factory(); - fcn2(); // $ExpectError - fcn2( 1 ); // $ExpectError - fcn2( 1, 1, 1, 1 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index c485546..0000000 --- a/examples/index.js +++ /dev/null @@ -1,48 +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'; - -var logEach = require( '@stdlib/console-log-each' ); -var uniform = require( './../lib' ); - -// Create a function for generating random arrays originating from the same state: -var random = uniform.factory( 2.0, 5.0, { - 'state': uniform.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 = uniform.factory( 2.0, 5.0, { - 'state': uniform.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 6fef7d9..e49ce72 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { FloatDataType, 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..e66e911 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.1.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-accessor@v0.1.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-write-accessor@v0.1.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-constant-function@v0.1.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-noop@v0.1.1-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/random-base-uniform@v0.1.0-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-typed-real-float-ctors@v0.1.0-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@v0.1.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-nullary@v0.1.0-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@v0.1.0-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/string-format@v0.1.1-esm/index.mjs";import f from"https://cdn.jsdelivr.net/gh/stdlib-js/array-typed-real-float-dtypes@v0.1.0-esm/index.mjs";import u from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.1.0-esm/index.mjs";import h from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.1.1-esm/index.mjs";var j="float64",g=f();function c(e,t){return u(t)?h(t,"dtype")&&(e.dtype=t.dtype,g.indexOf(e.dtype)<0)?new TypeError(p('invalid option. `%s` option must be one of the following: "%s". Option: `%s`.',"dtype",g.join('", "'),e.dtype)):null:new TypeError(p("invalid argument. Options argument must be an object. Value: `%s`.",t))}function v(){var f,u,h,g,v,y;if(h={dtype:j},0===(u=arguments.length))v=d,g=x;else if(1===u){if(f=arguments[0],v=d.factory(f),y=c(h,f))throw y;g=x}else if(2===u)v=d.factory(arguments[0],arguments[1]),g=b;else if(3===u){if(f=arguments[2],v=d.factory(arguments[0],arguments[1],f),y=c(h,f))throw y;g=b}return f&&f.prng?(e(g,"seed",null),e(g,"seedLength",null),s(g,"state",r(null),i),e(g,"stateLength",null),e(g,"byteLength",null)):(n(g,"seed",w),n(g,"seedLength",L),s(g,"state",P,R),n(g,"stateLength",G),n(g,"byteLength",N)),e(g,"PRNG",v.PRNG),g;function b(e,n){var s,r,i,d;if(!t(e))throw new TypeError(p("invalid argument. First argument must be a nonnegative integer. Value: `%s`.",e));if(d={},arguments.length>1&&(r=c(d,n)))throw r;return"generic"===(i=d.dtype||h.dtype)?l(e,v):(s=new(o(i))(e),m([s],[e],[1],v),s)}function x(e,n,s,r){var i,d,m,f;if(!t(e))throw new TypeError(p("invalid argument. First argument must be a nonnegative integer. Value: `%s`.",e));if(f={},arguments.length>3&&(d=c(f,r)))throw d;return"generic"===(m=f.dtype||h.dtype)?l(e,u):(i=new(o(m))(e),a([[n],[s],i],[e],[0,0,1],v),i);function u(){return v(n,s)}}function w(){return g.PRNG.seed}function L(){return g.PRNG.seedLength}function G(){return g.PRNG.stateLength}function N(){return g.PRNG.byteLength}function P(){return g.PRNG.state}function R(e){g.PRNG.state=e}}g.push("generic");var y=v();e(y,"factory",v);export{y as default,v as factory}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..b4fe4ef --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/factory.js","../lib/main.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 dtypes from '@stdlib/array-typed-real-float-dtypes';\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport format from '@stdlib/string-format';\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes();\nDTYPES.push( 'generic' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( DTYPES.indexOf( opts.dtype ) < 0 ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be one of the following: \"%s\". Option: `%s`.', 'dtype', DTYPES.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport setReadOnlyAccessor from '@stdlib/utils-define-nonenumerable-read-only-accessor';\nimport setReadWriteAccessor from '@stdlib/utils-define-nonenumerable-read-write-accessor';\nimport constantFunction from '@stdlib/utils-constant-function';\nimport noop from '@stdlib/utils-noop';\nimport base from '@stdlib/random-base-uniform';\nimport ctors from '@stdlib/array-typed-real-float-ctors';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport nullary from '@stdlib/strided-base-nullary';\nimport binary from '@stdlib/strided-base-binary';\nimport format from '@stdlib/string-format';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution.\n*\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\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 {RangeError} `a` must be less than `b`\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 uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10 );\n* // returns \n*\n* @example\n* var uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nfunction factory() {\n\tvar options;\n\tvar nargs;\n\tvar opts;\n\tvar rand;\n\tvar prng;\n\tvar err;\n\n\topts = {\n\t\t'dtype': defaults.dtype\n\t};\n\n\tnargs = arguments.length;\n\tif ( nargs === 0 ) {\n\t\tprng = base;\n\t\trand = uniform2;\n\t} else if ( nargs === 1 ) {\n\t\toptions = arguments[ 0 ];\n\t\tprng = base.factory( options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform2;\n\t} else if ( nargs === 2 ) {\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ] );\n\t\trand = uniform1;\n\t} else if ( nargs === 3 ) {\n\t\toptions = arguments[ 2 ];\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ], options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform1;\n\t}\n\tif ( options && options.prng ) {\n\t\tsetReadOnly( rand, 'seed', null );\n\t\tsetReadOnly( rand, 'seedLength', null );\n\t\tsetReadWriteAccessor( rand, 'state', constantFunction( null ), noop );\n\t\tsetReadOnly( rand, 'stateLength', null );\n\t\tsetReadOnly( rand, 'byteLength', null );\n\t} else {\n\t\tsetReadOnlyAccessor( rand, 'seed', getSeed );\n\t\tsetReadOnlyAccessor( rand, 'seedLength', getSeedLength );\n\t\tsetReadWriteAccessor( rand, 'state', getState, setState );\n\t\tsetReadOnlyAccessor( rand, 'stateLength', getStateLength );\n\t\tsetReadOnlyAccessor( rand, 'byteLength', getStateSize );\n\t}\n\tsetReadOnly( rand, 'PRNG', prng.PRNG );\n\treturn rand;\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform1( len, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 1 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, prng );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tnullary( [ out ], [ len ], [ 1 ], prng );\n\t\treturn out;\n\t}\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {number} a - minimum support\n\t* @param {number} b - maximum support\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform2( len, a, b, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 3 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\t// NOTE: we could alternatively use the PRNG factory function to create a PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. Decision made here to avoid this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom number. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in a return value of `NaN`.\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, wrapper );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tbinary( [ [ a ], [ b ], out ], [ len ], [ 0, 0, 1 ], prng );\n\t\treturn out;\n\n\t\t/**\n\t\t* Applies parameters to a pseudorandom number generator function.\n\t\t*\n\t\t* @private\n\t\t* @returns {number} pseudorandom number\n\t\t*/\n\t\tfunction wrapper() {\n\t\t\treturn prng( a, b );\n\t\t}\n\t}\n\n\t/**\n\t* Returns the PRNG seed.\n\t*\n\t* @private\n\t* @returns {PRNGSeedMT19937} seed\n\t*/\n\tfunction getSeed() {\n\t\treturn rand.PRNG.seed;\n\t}\n\n\t/**\n\t* Returns the PRNG seed length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} seed length\n\t*/\n\tfunction getSeedLength() {\n\t\treturn rand.PRNG.seedLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state length\n\t*/\n\tfunction getStateLength() {\n\t\treturn rand.PRNG.stateLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state size (in bytes).\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state size (in bytes)\n\t*/\n\tfunction getStateSize() {\n\t\treturn rand.PRNG.byteLength;\n\t}\n\n\t/**\n\t* Returns the current pseudorandom number generator state.\n\t*\n\t* @private\n\t* @returns {PRNGStateMT19937} current state\n\t*/\n\tfunction getState() {\n\t\treturn rand.PRNG.state;\n\t}\n\n\t/**\n\t* Sets the pseudorandom number generator state.\n\t*\n\t* @private\n\t* @param {PRNGStateMT19937} s - generator state\n\t* @throws {Error} must provide a valid state\n\t*/\n\tfunction setState( s ) {\n\t\trand.PRNG.state = s;\n\t}\n}\n\n\n// EXPORTS //\n\nexport default factory;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @name uniform\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\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 = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar uniform = factory();\n\n\n// EXPORTS //\n\nexport default uniform;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @module @stdlib/random-array-uniform\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.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\" }\n"],"names":["DTYPES","dtypes","validate","opts","options","isObject","hasOwnProp","dtype","indexOf","TypeError","format","join","factory","nargs","rand","prng","err","defaults","arguments","length","base","uniform2","uniform1","setReadOnly","setReadWriteAccessor","constantFunction","noop","setReadOnlyAccessor","getSeed","getSeedLength","getState","setState","getStateLength","getStateSize","PRNG","len","out","dt","o","isNonNegativeInteger","filledBy","ctors","nullary","a","b","wrapper","binary","seed","seedLength","stateLength","byteLength","state","s","push","uniform","main"],"mappings":";;2gDA8BIA,EAASC,IAyBb,SAASC,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,WACzBD,EAAKI,MAAQH,EAAQG,MAChBP,EAAOQ,QAASL,EAAKI,OAAU,GAC5B,IAAIE,UAAWC,EAAQ,gFAAiF,QAASV,EAAOW,KAAM,QAAUR,EAAKI,QAG/I,KARC,IAAIE,UAAWC,EAAQ,qEAAsEN,GAStG,CCSA,SAASQ,IACR,IAAIR,EACAS,EACAV,EACAW,EACAC,EACAC,EAOJ,GALAb,EAAO,CACNI,MAASU,GAIK,KADfJ,EAAQK,UAAUC,QAEjBJ,EAAOK,EACPN,EAAOO,OACD,GAAe,IAAVR,EAAc,CAIzB,GAHAT,EAAUc,UAAW,GACrBH,EAAOK,EAAKR,QAASR,GACrBY,EAAMd,EAAUC,EAAMC,GAErB,MAAMY,EAEPF,EAAOO,CACT,MAAQ,GAAe,IAAVR,EACXE,EAAOK,EAAKR,QAASM,UAAW,GAAKA,UAAW,IAChDJ,EAAOQ,OACD,GAAe,IAAVT,EAAc,CAIzB,GAHAT,EAAUc,UAAW,GACrBH,EAAOK,EAAKR,QAASM,UAAW,GAAKA,UAAW,GAAKd,GACrDY,EAAMd,EAAUC,EAAMC,GAErB,MAAMY,EAEPF,EAAOQ,CACP,CAeD,OAdKlB,GAAWA,EAAQW,MACvBQ,EAAaT,EAAM,OAAQ,MAC3BS,EAAaT,EAAM,aAAc,MACjCU,EAAsBV,EAAM,QAASW,EAAkB,MAAQC,GAC/DH,EAAaT,EAAM,cAAe,MAClCS,EAAaT,EAAM,aAAc,QAEjCa,EAAqBb,EAAM,OAAQc,GACnCD,EAAqBb,EAAM,aAAce,GACzCL,EAAsBV,EAAM,QAASgB,EAAUC,GAC/CJ,EAAqBb,EAAM,cAAekB,GAC1CL,EAAqBb,EAAM,aAAcmB,IAE1CV,EAAaT,EAAM,OAAQC,EAAKmB,MACzBpB,EAcP,SAASQ,EAAUa,EAAK/B,GACvB,IACIgC,EACApB,EACAqB,EACAC,EACJ,IAAMC,EAAsBJ,GAC3B,MAAM,IAAI1B,UAAWC,EAAQ,+EAAgFyB,IAG9G,GADAG,EAAI,CAAA,EACCpB,UAAUC,OAAS,IACvBH,EAAMd,EAAUoC,EAAGlC,IAElB,MAAMY,EAIR,MAAY,aADZqB,EAAKC,EAAE/B,OAASJ,EAAKI,OAEbiC,EAAUL,EAAKpB,IAGvBqB,EAAM,IADCK,EAAOJ,GACR,CAAUF,GAChBO,EAAS,CAAEN,GAAO,CAAED,GAAO,CAAE,GAAKpB,GAC3BqB,EACP,CAgBD,SAASf,EAAUc,EAAKQ,EAAGC,EAAGxC,GAC7B,IACIgC,EACApB,EACAqB,EACAC,EACJ,IAAMC,EAAsBJ,GAC3B,MAAM,IAAI1B,UAAWC,EAAQ,+EAAgFyB,IAG9G,GADAG,EAAI,CAAA,EACCpB,UAAUC,OAAS,IACvBH,EAAMd,EAAUoC,EAAGlC,IAElB,MAAMY,EAKR,MAAY,aADZqB,EAAKC,EAAE/B,OAASJ,EAAKI,OAEbiC,EAAUL,EAAKU,IAGvBT,EAAM,IADCK,EAAOJ,GACR,CAAUF,GAChBW,EAAQ,CAAE,CAAEH,GAAK,CAAEC,GAAKR,GAAO,CAAED,GAAO,CAAE,EAAG,EAAG,GAAKpB,GAC9CqB,GAQP,SAASS,IACR,OAAO9B,EAAM4B,EAAGC,EAChB,CACD,CAQD,SAAShB,IACR,OAAOd,EAAKoB,KAAKa,IACjB,CAQD,SAASlB,IACR,OAAOf,EAAKoB,KAAKc,UACjB,CAQD,SAAShB,IACR,OAAOlB,EAAKoB,KAAKe,WACjB,CAQD,SAAShB,IACR,OAAOnB,EAAKoB,KAAKgB,UACjB,CAQD,SAASpB,IACR,OAAOhB,EAAKoB,KAAKiB,KACjB,CASD,SAASpB,EAAUqB,GAClBtC,EAAKoB,KAAKiB,MAAQC,CAClB,CACF,CDrPApD,EAAOqD,KAAM,WEqBV,IAACC,EAAU1C,ICiBdW,EAAAgC,EAAA,UAAA3C"} \ No newline at end of file diff --git a/lib/defaults.json b/lib/defaults.json deleted file mode 100644 index 83f4438..0000000 --- a/lib/defaults.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "dtype": "float64" -} diff --git a/lib/factory.js b/lib/factory.js deleted file mode 100644 index 22ec236..0000000 --- a/lib/factory.js +++ /dev/null @@ -1,282 +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 isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var setReadOnlyAccessor = require( '@stdlib/utils-define-nonenumerable-read-only-accessor' ); -var setReadWriteAccessor = require( '@stdlib/utils-define-nonenumerable-read-write-accessor' ); -var constantFunction = require( '@stdlib/utils-constant-function' ); -var noop = require( '@stdlib/utils-noop' ); -var base = require( '@stdlib/random-base-uniform' ); -var ctors = require( '@stdlib/array-typed-real-float-ctors' ); -var filledBy = require( '@stdlib/array-base-filled-by' ); -var nullary = require( '@stdlib/strided-base-nullary' ); -var binary = require( '@stdlib/strided-base-binary' ); -var format = require( '@stdlib/string-format' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution. -* -* @param {number} [a] - minimum support -* @param {number} [b] - maximum support -* @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 {RangeError} `a` must be less than `b` -* @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 uniform = factory( 2.0, 5.0 ); -* // returns -* -* var arr = uniform( 10 ); -* // returns -* -* @example -* var uniform = factory( 2.0, 5.0 ); -* // returns -* -* var arr = uniform( 10, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -function factory() { - var options; - var nargs; - var opts; - var rand; - var prng; - var err; - - opts = { - 'dtype': defaults.dtype - }; - - nargs = arguments.length; - if ( nargs === 0 ) { - prng = base; - rand = uniform2; - } else if ( nargs === 1 ) { - options = arguments[ 0 ]; - prng = base.factory( options ); - err = validate( opts, options ); - if ( err ) { - throw err; - } - rand = uniform2; - } else if ( nargs === 2 ) { - prng = base.factory( arguments[ 0 ], arguments[ 1 ] ); - rand = uniform1; - } else if ( nargs === 3 ) { - options = arguments[ 2 ]; - prng = base.factory( arguments[ 0 ], arguments[ 1 ], options ); - err = validate( opts, options ); - if ( err ) { - throw err; - } - rand = uniform1; - } - if ( options && options.prng ) { - setReadOnly( rand, 'seed', null ); - setReadOnly( rand, 'seedLength', null ); - setReadWriteAccessor( rand, 'state', constantFunction( null ), noop ); - setReadOnly( rand, 'stateLength', null ); - setReadOnly( rand, 'byteLength', null ); - } else { - setReadOnlyAccessor( rand, 'seed', getSeed ); - setReadOnlyAccessor( rand, 'seedLength', getSeedLength ); - setReadWriteAccessor( rand, 'state', getState, setState ); - setReadOnlyAccessor( rand, 'stateLength', getStateLength ); - setReadOnlyAccessor( rand, 'byteLength', getStateSize ); - } - setReadOnly( rand, 'PRNG', prng.PRNG ); - return rand; - - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @private - * @param {NonNegativeInteger} len - array length - * @param {Options} [options] - function options - * @param {string} [options.dtype] - 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 - */ - function uniform1( len, options ) { - var ctor; - var out; - var err; - var dt; - var o; - if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) ); - } - o = {}; - if ( arguments.length > 1 ) { - err = validate( o, options ); - if ( err ) { - throw err; - } - } - dt = o.dtype || opts.dtype; - if ( dt === 'generic' ) { - return filledBy( len, prng ); - } - ctor = ctors( dt ); - out = new ctor( len ); - nullary( [ out ], [ len ], [ 1 ], prng ); - return out; - } - - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @private - * @param {NonNegativeInteger} len - array length - * @param {number} a - minimum support - * @param {number} b - maximum support - * @param {Options} [options] - function options - * @param {string} [options.dtype] - 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 - */ - function uniform2( len, a, b, options ) { - var ctor; - var out; - var err; - var dt; - var o; - if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) ); - } - o = {}; - if ( arguments.length > 3 ) { - err = validate( o, options ); - if ( err ) { - throw err; - } - } - // NOTE: we could alternatively use the PRNG factory function to create a PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. Decision made here to avoid this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom number. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in a return value of `NaN`. - dt = o.dtype || opts.dtype; - if ( dt === 'generic' ) { - return filledBy( len, wrapper ); - } - ctor = ctors( dt ); - out = new ctor( len ); - binary( [ [ a ], [ b ], out ], [ len ], [ 0, 0, 1 ], prng ); - return out; - - /** - * Applies parameters to a pseudorandom number generator function. - * - * @private - * @returns {number} pseudorandom number - */ - function wrapper() { - return prng( a, b ); - } - } - - /** - * Returns the PRNG seed. - * - * @private - * @returns {PRNGSeedMT19937} seed - */ - function getSeed() { - return rand.PRNG.seed; - } - - /** - * Returns the PRNG seed length. - * - * @private - * @returns {PositiveInteger} seed length - */ - function getSeedLength() { - return rand.PRNG.seedLength; - } - - /** - * Returns the PRNG state length. - * - * @private - * @returns {PositiveInteger} state length - */ - function getStateLength() { - return rand.PRNG.stateLength; - } - - /** - * Returns the PRNG state size (in bytes). - * - * @private - * @returns {PositiveInteger} state size (in bytes) - */ - function getStateSize() { - return rand.PRNG.byteLength; - } - - /** - * Returns the current pseudorandom number generator state. - * - * @private - * @returns {PRNGStateMT19937} current state - */ - function getState() { - return rand.PRNG.state; - } - - /** - * Sets the pseudorandom number generator state. - * - * @private - * @param {PRNGStateMT19937} s - generator state - * @throws {Error} must provide a valid state - */ - function setState( s ) { - rand.PRNG.state = s; - } -} - - -// EXPORTS // - -module.exports = factory; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 0077f00..0000000 --- a/lib/index.js +++ /dev/null @@ -1,77 +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'; - -/** -* Create an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. -* -* @module @stdlib/random-array-uniform -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var arr = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var arr = uniform( 10, 2.0, 5.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var rand = uniform.factory( 2.0, 5.0 ); -* // returns -* -* var arr = rand( 10 ); -* // returns -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var rand = uniform.factory( 2.0, 5.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" } diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index da0d9b1..0000000 --- a/lib/main.js +++ /dev/null @@ -1,58 +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 factory = require( './factory.js' ); - - -// MAIN // - -/** -* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. -* -* @name uniform -* @type {Function} -* @param {NonNegativeInteger} len - array length -* @param {number} a - minimum support -* @param {number} b - maximum support -* @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 = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var arr = uniform( 10, 2.0, 5.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -var uniform = factory(); - - -// EXPORTS // - -module.exports = uniform; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index 40b9723..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,72 +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 dtypes = require( '@stdlib/array-typed-real-float-dtypes' ); -var isObject = require( '@stdlib/assert-is-plain-object' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var format = require( '@stdlib/string-format' ); - - -// VARIABLES // - -var DTYPES = dtypes(); -DTYPES.push( 'generic' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Options} options - function options -* @param {string} [options.dtype] - output array data type -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var options = { -* 'dtype': 'float64' -* }; -* var err = validate( opts, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); - } - if ( hasOwnProp( options, 'dtype' ) ) { - opts.dtype = options.dtype; - if ( DTYPES.indexOf( opts.dtype ) < 0 ) { - return new TypeError( format( 'invalid option. `%s` option must be one of the following: "%s". Option: `%s`.', 'dtype', DTYPES.join( '", "' ), opts.dtype ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index 920af2f..767a213 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 continuous uniform 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,55 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-filled-by": "^0.1.0", - "@stdlib/array-typed-real-float-ctors": "^0.1.0", - "@stdlib/array-typed-real-float-dtypes": "^0.1.0", - "@stdlib/assert-has-own-property": "^0.1.1", - "@stdlib/assert-is-nonnegative-integer": "^0.1.0", - "@stdlib/assert-is-plain-object": "^0.1.1", - "@stdlib/random-base-uniform": "^0.1.0", - "@stdlib/strided-base-binary": "^0.1.0", - "@stdlib/strided-base-nullary": "^0.1.0", - "@stdlib/error-tools-fmtprodmsg": "^0.1.1", - "@stdlib/types": "^0.1.0", - "@stdlib/utils-constant-function": "^0.1.1", - "@stdlib/utils-define-nonenumerable-read-only-accessor": "^0.1.1", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1", - "@stdlib/utils-define-nonenumerable-read-write-accessor": "^0.1.1", - "@stdlib/utils-noop": "^0.1.1" - }, - "devDependencies": { - "@stdlib/array-float32": "^0.1.0", - "@stdlib/array-float64": "^0.1.0", - "@stdlib/array-uint32": "^0.1.0", - "@stdlib/assert-is-uint32array": "^0.1.1", - "@stdlib/bench": "^0.1.0", - "@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" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdmath", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..89f2efd --- /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 584b08e..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,69 +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 random = require( './../../dist' ); - - -// 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 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.factory.js b/test/test.factory.js deleted file mode 100644 index a869e75..0000000 --- a/test/test.factory.js +++ /dev/null @@ -1,1328 +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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -tape( 'the function throws an error if the second distribution parameter is less than the first distribution parameter', function test( t ) { - var values; - var i; - - values = [ - [ 0.0, 0.0 ], - [ -2.0, -4.0 ], - [ 2.0, 1.0 ] - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( arr ) { - return function badValue() { - factory( arr[0], arr[1] ); - }; - } -}); - -tape( 'the function throws an error if the second distribution parameter is less than the first distribution parameter (options)', function test( t ) { - var values; - var i; - - values = [ - [ 0.0, 0.0 ], - [ -2.0, -4.0 ], - [ 2.0, 1.0 ] - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( arr ) { - return function badValue() { - factory( arr[0], arr[1], {} ); - }; - } -}); - -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, 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, { - '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, { - '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, { - '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, { - '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, { - '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, { - '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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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 ); - - 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 ); - - 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, { - '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 ); - - 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 ); - 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( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory(); - actual = random( 10, 2.0, 5.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( typeof actual[ i ], 'number', '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 ); - - 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 ); - - 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 ); - - 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 that generates `NaN` values if the first distribution parameter is greater than or equal to the second distribution parameter', function test( t ) { - var random; - var values; - var actual; - var i; - var j; - - random = factory(); - values = [ - [ 2.0, 1.0 ], - [ -3.0, -4.0 ], - [ 0.0, 0.0 ] - ]; - - for ( i = 0; i < values.length; i++ ) { - actual = random( 10, values[ i ][ 0 ], values[ i ][ 1 ] ); - for ( j = 0; j < actual.length; j++ ) { - t.strictEqual( isnan( actual[ j ] ), true, 'returns expected value when provided '+values[ 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, { - '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 ); - - 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, { - '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( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'float64' - }); - actual = random( 10, 2.0, 5.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( typeof actual[ i ], 'number', '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, { - '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( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'float32' - }); - actual = random( 10, 2.0, 5.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( typeof actual[ i ], 'number', '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, { - '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 ); - - 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, { - '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, { - '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 ); - - // 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, { - '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 ); - - // 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, { - '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 ); - - 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, { - 'prng': randu.normalized - }); - - randu = minstd.factory({ - 'seed': seed - }); - random2 = factory( 2.0, 5.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 ); - arr2 = random2( 10, 2.0, 5.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 c4fb6d3..0000000 --- a/test/test.js +++ /dev/null @@ -1,69 +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 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 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 37b0080..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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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, 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, { - '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 ); - - 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( typeof actual[ i ], 'number', '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, { - '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( typeof actual[ i ], 'number', '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, { - '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( typeof actual[ i ], 'number', '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, { - '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 ); - } - // Capture the current state: - state = random.state; - - // Move to a future state... - arr = random( 10, 2.0, 5.0 ); - for ( i = 0; i < 100; i++ ) { - random( 2, 2.0, 5.0 ); - } - // Set the state: - random.state = state; - - // Replay previously generated values: - t.deepEqual( random( 10, 2.0, 5.0 ), arr, 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.validate.js b/test/test.validate.js deleted file mode 100644 index 9fbe15f..0000000 --- a/test/test.validate.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 validate = require( './../lib/validate.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof validate, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function returns an error if provided an options argument which is not an object', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - void 0, - null, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, values[ i ] ); - t.equal( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided a `dtype` option which is not a supported data type', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - -5, - NaN, - true, - false, - void 0, - null, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, { - 'dtype': values[ i ] - }); - t.equal( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns null if all options are valid', function test( t ) { - var options; - var opts; - var err; - - options = { - 'dtype': 'float64' - }; - opts = {}; - err = validate( opts, options ); - - t.equal( err, null, 'returns null' ); - t.deepEqual( opts, options, 'sets option values' ); - - t.end(); -}); - -tape( 'the function ignores unrecognized/unsupported options', function test( t ) { - var options; - var opts; - var err; - - options = { - 'beep': true, - 'boop': 'bop' - }; - opts = {}; - err = validate( opts, options ); - - t.equal( err, null, 'returns null' ); - t.deepEqual( opts, {}, 'does not set any option values' ); - t.end(); -}); From dc62775679910db5925d1978e9e2f9f11d0bd9ef Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 1 Nov 2023 19:16:47 +0000 Subject: [PATCH 37/82] Transform error messages --- lib/factory.js | 6 +++--- lib/validate.js | 6 +++--- package.json | 2 +- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/lib/factory.js b/lib/factory.js index 22ec236..24d5d10 100644 --- a/lib/factory.js +++ b/lib/factory.js @@ -31,7 +31,7 @@ var ctors = require( '@stdlib/array-typed-real-float-ctors' ); var filledBy = require( '@stdlib/array-base-filled-by' ); var nullary = require( '@stdlib/strided-base-nullary' ); var binary = require( '@stdlib/strided-base-binary' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -144,7 +144,7 @@ function factory() { var dt; var o; if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) ); + throw new TypeError( format( '1eR2d,MG', len ) ); } o = {}; if ( arguments.length > 1 ) { @@ -184,7 +184,7 @@ function factory() { var dt; var o; if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) ); + throw new TypeError( format( '1eR2d,MG', len ) ); } o = {}; if ( arguments.length > 3 ) { diff --git a/lib/validate.js b/lib/validate.js index 40b9723..1c3d511 100644 --- a/lib/validate.js +++ b/lib/validate.js @@ -23,7 +23,7 @@ var dtypes = require( '@stdlib/array-typed-real-float-dtypes' ); var isObject = require( '@stdlib/assert-is-plain-object' ); var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // VARIABLES // @@ -55,12 +55,12 @@ DTYPES.push( 'generic' ); */ function validate( opts, options ) { if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); + return new TypeError( format( '1eR2V,FD', options ) ); } if ( hasOwnProp( options, 'dtype' ) ) { opts.dtype = options.dtype; if ( DTYPES.indexOf( opts.dtype ) < 0 ) { - return new TypeError( format( 'invalid option. `%s` option must be one of the following: "%s". Option: `%s`.', 'dtype', DTYPES.join( '", "' ), opts.dtype ) ); + return new TypeError( format( '1eR2X,3g,4S,GD,Gg,Jm', 'dtype', DTYPES.join( '", "' ), opts.dtype ) ); } } return null; diff --git a/package.json b/package.json index 2cd84f3..74bcead 100644 --- a/package.json +++ b/package.json @@ -46,7 +46,7 @@ "@stdlib/random-base-uniform": "^0.1.0", "@stdlib/strided-base-binary": "^0.1.0", "@stdlib/strided-base-nullary": "^0.1.0", - "@stdlib/string-format": "^0.1.1", + "@stdlib/error-tools-fmtprodmsg": "^0.1.1", "@stdlib/types": "^0.1.0", "@stdlib/utils-constant-function": "^0.1.1", "@stdlib/utils-define-nonenumerable-read-only-accessor": "^0.1.1", From 5c6162a7e3c0e426dea1bb0a467840bba35c5398 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 3 Nov 2023 04:38:28 +0000 Subject: [PATCH 38/82] Remove files --- index.d.ts | 245 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6427 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 e49ce72..0000000 --- a/index.d.ts +++ /dev/null @@ -1,245 +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. -*/ - -// TypeScript Version: 4.1 - -/// - -import { FloatDataType, FloatTypedArray } from '@stdlib/types/array'; -import * as random from '@stdlib/types/random'; - -/** -* Supported data types. -*/ -type DataType = FloatDataType | 'generic'; - -/** -* 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 continuous uniform distribution with pre-specified parameter values. -*/ -interface UnaryFunction extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @param len - array length - * @param options - function options - * @returns output array - */ - ( len: number, options?: Options ): RandomArray; -} - -/** -* Interface for generating pseudorandom numbers drawn from a continuous uniform distribution without pre-specified parameter values. -*/ -interface TernaryFunction extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @param len - array length - * @param a - minimum support - * @param b - maximum support - * @param options - function options - * @returns output array - */ - ( len: number, a: number, b: number, options?: Options ): RandomArray; -} - -/** -* Interface for generating pseudorandom numbers drawn from a uniform distribution. -*/ -interface Random extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @param len - array length - * @param a - minimum support - * @param b - maximum support - * @param options - function options - * @returns output array - * - * @example - * var out = uniform( 10, 2.0, 5.0 ); - * // returns - */ - ( len: number, a: number, b: number, options?: Options ): RandomArray; - - /** - * Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution. - * - * ## Notes - * - * - When provided `a` and `b`, the returned function returns random variates drawn from the specified distribution. - * - * @param a - minimum support - * @param b - maximum support - * @param options - function options - * @throws `a` must be less than `b` - * @throws must provide a valid state - * @returns function for creating arrays - * - * @example - * var random = uniform.factory( 2.0, 5.0 ); - * - * var out = random( 10 ); - * // returns - * - * @example - * var random = uniform.factory( 2.0, 5.0, { - * 'seed': 297 - * }); - * var out = random( 10 ); - * // returns - */ - factory( a: number, b: number, options?: FactoryOptions ): UnaryFunction; - - /** - * Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution. - * - * ## Notes - * - * - When not provided `a` and `b`, the returned function requires that both `a` and `b` be provided at each invocation. - * - * @param options - function options - * @throws must provide a valid state - * @returns function for creating arrays - * - * @example - * var random = uniform.factory(); - * - * var out = random( 10, 2.0, 5.0 ); - * // returns - * - * @example - * var random = uniform.factory({ - * 'seed': 297 - * }); - * var out = random( 10, 2.0, 5.0 ); - * // returns - */ - factory( options?: FactoryOptions ): TernaryFunction; -} - -/** -* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. -* -* @param len - array length -* @param a - minimum support -* @param b - maximum support -* @param options - function options -* @returns output array -* -* @example -* var out = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var random = uniform.factory( 2.0, 5.0 ); -* -* var out = random( 10 ); -* // returns -*/ -declare var uniform: Random; - - -// EXPORTS // - -export = uniform; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index e66e911..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.1.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-accessor@v0.1.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-write-accessor@v0.1.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-constant-function@v0.1.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-noop@v0.1.1-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/random-base-uniform@v0.1.0-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-typed-real-float-ctors@v0.1.0-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@v0.1.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-nullary@v0.1.0-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@v0.1.0-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/string-format@v0.1.1-esm/index.mjs";import f from"https://cdn.jsdelivr.net/gh/stdlib-js/array-typed-real-float-dtypes@v0.1.0-esm/index.mjs";import u from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.1.0-esm/index.mjs";import h from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.1.1-esm/index.mjs";var j="float64",g=f();function c(e,t){return u(t)?h(t,"dtype")&&(e.dtype=t.dtype,g.indexOf(e.dtype)<0)?new TypeError(p('invalid option. `%s` option must be one of the following: "%s". Option: `%s`.',"dtype",g.join('", "'),e.dtype)):null:new TypeError(p("invalid argument. Options argument must be an object. Value: `%s`.",t))}function v(){var f,u,h,g,v,y;if(h={dtype:j},0===(u=arguments.length))v=d,g=x;else if(1===u){if(f=arguments[0],v=d.factory(f),y=c(h,f))throw y;g=x}else if(2===u)v=d.factory(arguments[0],arguments[1]),g=b;else if(3===u){if(f=arguments[2],v=d.factory(arguments[0],arguments[1],f),y=c(h,f))throw y;g=b}return f&&f.prng?(e(g,"seed",null),e(g,"seedLength",null),s(g,"state",r(null),i),e(g,"stateLength",null),e(g,"byteLength",null)):(n(g,"seed",w),n(g,"seedLength",L),s(g,"state",P,R),n(g,"stateLength",G),n(g,"byteLength",N)),e(g,"PRNG",v.PRNG),g;function b(e,n){var s,r,i,d;if(!t(e))throw new TypeError(p("invalid argument. First argument must be a nonnegative integer. Value: `%s`.",e));if(d={},arguments.length>1&&(r=c(d,n)))throw r;return"generic"===(i=d.dtype||h.dtype)?l(e,v):(s=new(o(i))(e),m([s],[e],[1],v),s)}function x(e,n,s,r){var i,d,m,f;if(!t(e))throw new TypeError(p("invalid argument. First argument must be a nonnegative integer. Value: `%s`.",e));if(f={},arguments.length>3&&(d=c(f,r)))throw d;return"generic"===(m=f.dtype||h.dtype)?l(e,u):(i=new(o(m))(e),a([[n],[s],i],[e],[0,0,1],v),i);function u(){return v(n,s)}}function w(){return g.PRNG.seed}function L(){return g.PRNG.seedLength}function G(){return g.PRNG.stateLength}function N(){return g.PRNG.byteLength}function P(){return g.PRNG.state}function R(e){g.PRNG.state=e}}g.push("generic");var y=v();e(y,"factory",v);export{y as default,v as factory}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index b4fe4ef..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/factory.js","../lib/main.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 dtypes from '@stdlib/array-typed-real-float-dtypes';\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport format from '@stdlib/string-format';\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes();\nDTYPES.push( 'generic' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( DTYPES.indexOf( opts.dtype ) < 0 ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be one of the following: \"%s\". Option: `%s`.', 'dtype', DTYPES.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport setReadOnlyAccessor from '@stdlib/utils-define-nonenumerable-read-only-accessor';\nimport setReadWriteAccessor from '@stdlib/utils-define-nonenumerable-read-write-accessor';\nimport constantFunction from '@stdlib/utils-constant-function';\nimport noop from '@stdlib/utils-noop';\nimport base from '@stdlib/random-base-uniform';\nimport ctors from '@stdlib/array-typed-real-float-ctors';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport nullary from '@stdlib/strided-base-nullary';\nimport binary from '@stdlib/strided-base-binary';\nimport format from '@stdlib/string-format';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution.\n*\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\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 {RangeError} `a` must be less than `b`\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 uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10 );\n* // returns \n*\n* @example\n* var uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nfunction factory() {\n\tvar options;\n\tvar nargs;\n\tvar opts;\n\tvar rand;\n\tvar prng;\n\tvar err;\n\n\topts = {\n\t\t'dtype': defaults.dtype\n\t};\n\n\tnargs = arguments.length;\n\tif ( nargs === 0 ) {\n\t\tprng = base;\n\t\trand = uniform2;\n\t} else if ( nargs === 1 ) {\n\t\toptions = arguments[ 0 ];\n\t\tprng = base.factory( options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform2;\n\t} else if ( nargs === 2 ) {\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ] );\n\t\trand = uniform1;\n\t} else if ( nargs === 3 ) {\n\t\toptions = arguments[ 2 ];\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ], options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform1;\n\t}\n\tif ( options && options.prng ) {\n\t\tsetReadOnly( rand, 'seed', null );\n\t\tsetReadOnly( rand, 'seedLength', null );\n\t\tsetReadWriteAccessor( rand, 'state', constantFunction( null ), noop );\n\t\tsetReadOnly( rand, 'stateLength', null );\n\t\tsetReadOnly( rand, 'byteLength', null );\n\t} else {\n\t\tsetReadOnlyAccessor( rand, 'seed', getSeed );\n\t\tsetReadOnlyAccessor( rand, 'seedLength', getSeedLength );\n\t\tsetReadWriteAccessor( rand, 'state', getState, setState );\n\t\tsetReadOnlyAccessor( rand, 'stateLength', getStateLength );\n\t\tsetReadOnlyAccessor( rand, 'byteLength', getStateSize );\n\t}\n\tsetReadOnly( rand, 'PRNG', prng.PRNG );\n\treturn rand;\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform1( len, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 1 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, prng );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tnullary( [ out ], [ len ], [ 1 ], prng );\n\t\treturn out;\n\t}\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {number} a - minimum support\n\t* @param {number} b - maximum support\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform2( len, a, b, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 3 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\t// NOTE: we could alternatively use the PRNG factory function to create a PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. Decision made here to avoid this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom number. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in a return value of `NaN`.\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, wrapper );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tbinary( [ [ a ], [ b ], out ], [ len ], [ 0, 0, 1 ], prng );\n\t\treturn out;\n\n\t\t/**\n\t\t* Applies parameters to a pseudorandom number generator function.\n\t\t*\n\t\t* @private\n\t\t* @returns {number} pseudorandom number\n\t\t*/\n\t\tfunction wrapper() {\n\t\t\treturn prng( a, b );\n\t\t}\n\t}\n\n\t/**\n\t* Returns the PRNG seed.\n\t*\n\t* @private\n\t* @returns {PRNGSeedMT19937} seed\n\t*/\n\tfunction getSeed() {\n\t\treturn rand.PRNG.seed;\n\t}\n\n\t/**\n\t* Returns the PRNG seed length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} seed length\n\t*/\n\tfunction getSeedLength() {\n\t\treturn rand.PRNG.seedLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state length\n\t*/\n\tfunction getStateLength() {\n\t\treturn rand.PRNG.stateLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state size (in bytes).\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state size (in bytes)\n\t*/\n\tfunction getStateSize() {\n\t\treturn rand.PRNG.byteLength;\n\t}\n\n\t/**\n\t* Returns the current pseudorandom number generator state.\n\t*\n\t* @private\n\t* @returns {PRNGStateMT19937} current state\n\t*/\n\tfunction getState() {\n\t\treturn rand.PRNG.state;\n\t}\n\n\t/**\n\t* Sets the pseudorandom number generator state.\n\t*\n\t* @private\n\t* @param {PRNGStateMT19937} s - generator state\n\t* @throws {Error} must provide a valid state\n\t*/\n\tfunction setState( s ) {\n\t\trand.PRNG.state = s;\n\t}\n}\n\n\n// EXPORTS //\n\nexport default factory;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @name uniform\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\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 = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar uniform = factory();\n\n\n// EXPORTS //\n\nexport default uniform;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @module @stdlib/random-array-uniform\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.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\" }\n"],"names":["DTYPES","dtypes","validate","opts","options","isObject","hasOwnProp","dtype","indexOf","TypeError","format","join","factory","nargs","rand","prng","err","defaults","arguments","length","base","uniform2","uniform1","setReadOnly","setReadWriteAccessor","constantFunction","noop","setReadOnlyAccessor","getSeed","getSeedLength","getState","setState","getStateLength","getStateSize","PRNG","len","out","dt","o","isNonNegativeInteger","filledBy","ctors","nullary","a","b","wrapper","binary","seed","seedLength","stateLength","byteLength","state","s","push","uniform","main"],"mappings":";;2gDA8BIA,EAASC,IAyBb,SAASC,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,WACzBD,EAAKI,MAAQH,EAAQG,MAChBP,EAAOQ,QAASL,EAAKI,OAAU,GAC5B,IAAIE,UAAWC,EAAQ,gFAAiF,QAASV,EAAOW,KAAM,QAAUR,EAAKI,QAG/I,KARC,IAAIE,UAAWC,EAAQ,qEAAsEN,GAStG,CCSA,SAASQ,IACR,IAAIR,EACAS,EACAV,EACAW,EACAC,EACAC,EAOJ,GALAb,EAAO,CACNI,MAASU,GAIK,KADfJ,EAAQK,UAAUC,QAEjBJ,EAAOK,EACPN,EAAOO,OACD,GAAe,IAAVR,EAAc,CAIzB,GAHAT,EAAUc,UAAW,GACrBH,EAAOK,EAAKR,QAASR,GACrBY,EAAMd,EAAUC,EAAMC,GAErB,MAAMY,EAEPF,EAAOO,CACT,MAAQ,GAAe,IAAVR,EACXE,EAAOK,EAAKR,QAASM,UAAW,GAAKA,UAAW,IAChDJ,EAAOQ,OACD,GAAe,IAAVT,EAAc,CAIzB,GAHAT,EAAUc,UAAW,GACrBH,EAAOK,EAAKR,QAASM,UAAW,GAAKA,UAAW,GAAKd,GACrDY,EAAMd,EAAUC,EAAMC,GAErB,MAAMY,EAEPF,EAAOQ,CACP,CAeD,OAdKlB,GAAWA,EAAQW,MACvBQ,EAAaT,EAAM,OAAQ,MAC3BS,EAAaT,EAAM,aAAc,MACjCU,EAAsBV,EAAM,QAASW,EAAkB,MAAQC,GAC/DH,EAAaT,EAAM,cAAe,MAClCS,EAAaT,EAAM,aAAc,QAEjCa,EAAqBb,EAAM,OAAQc,GACnCD,EAAqBb,EAAM,aAAce,GACzCL,EAAsBV,EAAM,QAASgB,EAAUC,GAC/CJ,EAAqBb,EAAM,cAAekB,GAC1CL,EAAqBb,EAAM,aAAcmB,IAE1CV,EAAaT,EAAM,OAAQC,EAAKmB,MACzBpB,EAcP,SAASQ,EAAUa,EAAK/B,GACvB,IACIgC,EACApB,EACAqB,EACAC,EACJ,IAAMC,EAAsBJ,GAC3B,MAAM,IAAI1B,UAAWC,EAAQ,+EAAgFyB,IAG9G,GADAG,EAAI,CAAA,EACCpB,UAAUC,OAAS,IACvBH,EAAMd,EAAUoC,EAAGlC,IAElB,MAAMY,EAIR,MAAY,aADZqB,EAAKC,EAAE/B,OAASJ,EAAKI,OAEbiC,EAAUL,EAAKpB,IAGvBqB,EAAM,IADCK,EAAOJ,GACR,CAAUF,GAChBO,EAAS,CAAEN,GAAO,CAAED,GAAO,CAAE,GAAKpB,GAC3BqB,EACP,CAgBD,SAASf,EAAUc,EAAKQ,EAAGC,EAAGxC,GAC7B,IACIgC,EACApB,EACAqB,EACAC,EACJ,IAAMC,EAAsBJ,GAC3B,MAAM,IAAI1B,UAAWC,EAAQ,+EAAgFyB,IAG9G,GADAG,EAAI,CAAA,EACCpB,UAAUC,OAAS,IACvBH,EAAMd,EAAUoC,EAAGlC,IAElB,MAAMY,EAKR,MAAY,aADZqB,EAAKC,EAAE/B,OAASJ,EAAKI,OAEbiC,EAAUL,EAAKU,IAGvBT,EAAM,IADCK,EAAOJ,GACR,CAAUF,GAChBW,EAAQ,CAAE,CAAEH,GAAK,CAAEC,GAAKR,GAAO,CAAED,GAAO,CAAE,EAAG,EAAG,GAAKpB,GAC9CqB,GAQP,SAASS,IACR,OAAO9B,EAAM4B,EAAGC,EAChB,CACD,CAQD,SAAShB,IACR,OAAOd,EAAKoB,KAAKa,IACjB,CAQD,SAASlB,IACR,OAAOf,EAAKoB,KAAKc,UACjB,CAQD,SAAShB,IACR,OAAOlB,EAAKoB,KAAKe,WACjB,CAQD,SAAShB,IACR,OAAOnB,EAAKoB,KAAKgB,UACjB,CAQD,SAASpB,IACR,OAAOhB,EAAKoB,KAAKiB,KACjB,CASD,SAASpB,EAAUqB,GAClBtC,EAAKoB,KAAKiB,MAAQC,CAClB,CACF,CDrPApD,EAAOqD,KAAM,WEqBV,IAACC,EAAU1C,ICiBdW,EAAAgC,EAAA,UAAA3C"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 89f2efd..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 9e34c556d90726fc2a10d25f0cb0eea7e7df55b0 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 3 Nov 2023 04:41:12 +0000 Subject: [PATCH 39/82] Auto-generated commit --- .editorconfig | 186 - .eslintrc.js | 1 - .gitattributes | 49 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 --- .github/workflows/publish.yml | 255 - .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 128 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 227 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 61 +- benchmark/benchmark.float32.factory.js | 96 - benchmark/benchmark.float32.js | 98 - benchmark/benchmark.float64.factory.js | 96 - benchmark/benchmark.float64.js | 98 - benchmark/benchmark.generic.factory.js | 96 - benchmark/benchmark.generic.js | 98 - branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 9 - dist/index.js.map | 7 - docs/repl.txt | 169 - docs/types/test.ts | 355 -- examples/index.js | 48 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/defaults.json | 3 - lib/factory.js | 282 - lib/index.js | 77 - lib/main.js | 58 - lib/validate.js | 72 - package.json | 76 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.factory.js | 1328 ----- test/test.js | 69 - test/test.main.js | 244 - test/test.validate.js | 118 - 53 files changed, 6215 insertions(+), 6784 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 benchmark/benchmark.float32.factory.js delete mode 100644 benchmark/benchmark.float32.js delete mode 100644 benchmark/benchmark.float64.factory.js delete mode 100644 benchmark/benchmark.float64.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/defaults.json delete mode 100644 lib/factory.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.factory.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js delete mode 100644 test/test.validate.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 13e9c39..0000000 --- a/.editorconfig +++ /dev/null @@ -1,186 +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 `tslint.json` files: -[tslint.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 cd951c3..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2023-11-01T06:25:01.065Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index c4ab52b..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/uniform) 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 ab56cca..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 corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # 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: 16 - 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 5097056..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/uniform) 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 c1c45e7..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 corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # 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: 16 - 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 bd8d245..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: '33 9 * * 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 corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - 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: 16 - 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 corresponding to v3.0.3: - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 - 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 265afda..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 corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - 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: 16 - 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 corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - 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: 16 - 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 corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # 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: 16 - 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 corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # 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: 16 - 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 + + ```
@@ -375,7 +374,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]. @@ -435,13 +434,13 @@ Copyright © 2016-2023. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/random-array-uniform/main/LICENSE -[@stdlib/random/base/uniform]: https://github.com/stdlib-js/random-base-uniform +[@stdlib/random/base/uniform]: https://github.com/stdlib-js/random-base-uniform/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/benchmark/benchmark.float32.factory.js b/benchmark/benchmark.float32.factory.js deleted file mode 100644 index 67e61f4..0000000 --- a/benchmark/benchmark.float32.factory.js +++ /dev/null @@ -1,96 +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 bench = require( '@stdlib/bench' ); -var isnanf = require( '@stdlib/math-base-assert-is-nanf' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var fcn = uniform.factory( 2.0, 5.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 4642816..0000000 --- a/benchmark/benchmark.float32.js +++ /dev/null @@ -1,98 +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 bench = require( '@stdlib/bench' ); -var isnanf = require( '@stdlib/math-base-assert-is-nanf' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = 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 = uniform( len, 2.0, 5.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.factory.js b/benchmark/benchmark.float64.factory.js deleted file mode 100644 index 8646a54..0000000 --- a/benchmark/benchmark.float64.factory.js +++ /dev/null @@ -1,96 +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 bench = require( '@stdlib/bench' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var fcn = uniform.factory( 2.0, 5.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 5ee0d97..0000000 --- a/benchmark/benchmark.float64.js +++ /dev/null @@ -1,98 +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 bench = require( '@stdlib/bench' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = 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 = uniform( len, 2.0, 5.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.factory.js b/benchmark/benchmark.generic.factory.js deleted file mode 100644 index 7020d62..0000000 --- a/benchmark/benchmark.generic.factory.js +++ /dev/null @@ -1,96 +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 bench = require( '@stdlib/bench' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var fcn = uniform.factory( 2.0, 5.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 06a2a83..0000000 --- a/benchmark/benchmark.generic.js +++ /dev/null @@ -1,98 +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 bench = require( '@stdlib/bench' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = 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 = uniform( len, 2.0, 5.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 30542fb..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/uniform" -%% click B href "https://github.com/stdlib-js/random-array-uniform/tree/main" -%% click C href "https://github.com/stdlib-js/random-array-uniform/tree/production" -%% click D href "https://github.com/stdlib-js/random-array-uniform/tree/esm" -%% click E href "https://github.com/stdlib-js/random-array-uniform/tree/deno" -%% click F href "https://github.com/stdlib-js/random-array-uniform/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/uniform -[production-url]: https://github.com/stdlib-js/random-array-uniform/tree/production -[deno-url]: https://github.com/stdlib-js/random-array-uniform/tree/deno -[umd-url]: https://github.com/stdlib-js/random-array-uniform/tree/umd -[esm-url]: https://github.com/stdlib-js/random-array-uniform/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 f2a679f..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import uniform from '../docs/types/index'; -export = uniform; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 0ef1443..0000000 --- a/dist/index.js +++ /dev/null @@ -1,9 +0,0 @@ -"use strict";var y=function(t,r){return function(){return r||t((r={exports:{}}).exports,r),r.exports}};var b=y(function(ue,H){H.exports={dtype:"float64"}});var O=y(function(se,G){ -var J=require('@stdlib/array-typed-real-float-dtypes/dist'),K=require('@stdlib/assert-is-plain-object/dist'),M=require('@stdlib/assert-has-own-property/dist'),N=require('@stdlib/error-tools-fmtprodmsg/dist'),w=J();w.push("generic");function Q(t,r){return K(r)?M(r,"dtype")&&(t.dtype=r.dtype,w.indexOf(t.dtype)<0)?new TypeError(N('1eR4S',"dtype",w.join('", "'),t.dtype)):null:new TypeError(N('1eR2V',r));}G.exports=Q -});var R=y(function(oe,F){ -var S=require('@stdlib/assert-is-nonnegative-integer/dist').isPrimitive,d=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),l=require('@stdlib/utils-define-nonenumerable-read-only-accessor/dist'),x=require('@stdlib/utils-define-nonenumerable-read-write-accessor/dist'),U=require('@stdlib/utils-constant-function/dist'),X=require('@stdlib/utils-noop/dist'),p=require('@stdlib/random-base-uniform/dist'),E=require('@stdlib/array-typed-real-float-ctors/dist'),T=require('@stdlib/array-base-filled-by/dist'),Z=require('@stdlib/strided-base-nullary/dist'),_=require('@stdlib/strided-base-binary/dist'),j=require('@stdlib/error-tools-fmtprodmsg/dist'),$=b(),m=O();function ee(){var t,r,v,e,a,s;if(v={dtype:$.dtype},r=arguments.length,r===0)a=p,e=P;else if(r===1){if(t=arguments[0],a=p.factory(t),s=m(v,t),s)throw s;e=P}else if(r===2)a=p.factory(arguments[0],arguments[1]),e=L;else if(r===3){if(t=arguments[2],a=p.factory(arguments[0],arguments[1],t),s=m(v,t),s)throw s;e=L}return t&&t.prng?(d(e,"seed",null),d(e,"seedLength",null),x(e,"state",U(null),X),d(e,"stateLength",null),d(e,"byteLength",null)):(l(e,"seed",B),l(e,"seedLength",D),x(e,"state",Y,k),l(e,"stateLength",I),l(e,"byteLength",W)),d(e,"PRNG",a.PRNG),e;function L(n,c){var f,g,o,i,u;if(!S(n))throw new TypeError(j('1eR2d',n));if(u={},arguments.length>1&&(o=m(u,c),o))throw o;return i=u.dtype||v.dtype,i==="generic"?T(n,a):(f=E(i),g=new f(n),Z([g],[n],[1],a),g)}function P(n,c,f,g){var o,i,u,h,q;if(!S(n))throw new TypeError(j('1eR2d',n));if(q={},arguments.length>3&&(u=m(q,g),u))throw u;if(h=q.dtype||v.dtype,h==="generic")return T(n,C);return o=E(h),i=new o(n),_([[c],[f],i],[n],[0,0,1],a),i;function C(){return a(c,f)}}function B(){return e.PRNG.seed}function D(){return e.PRNG.seedLength}function I(){return e.PRNG.stateLength}function W(){return e.PRNG.byteLength}function Y(){return e.PRNG.state}function k(n){e.PRNG.state=n}}F.exports=ee -});var A=y(function(ve,V){ -var re=R(),te=re();V.exports=te -});var ne=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),z=A(),ae=R();ne(z,"factory",ae);module.exports=z; -/** @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 fcb8851..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/defaults.json", "../lib/validate.js", "../lib/factory.js", "../lib/main.js", "../lib/index.js"], - "sourcesContent": ["{\n\t\"dtype\": \"float64\"\n}\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 dtypes = require( '@stdlib/array-typed-real-float-dtypes' );\nvar isObject = require( '@stdlib/assert-is-plain-object' );\nvar hasOwnProp = require( '@stdlib/assert-has-own-property' );\nvar format = require( '@stdlib/string-format' );\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes();\nDTYPES.push( 'generic' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( DTYPES.indexOf( opts.dtype ) < 0 ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be one of the following: \"%s\". Option: `%s`.', 'dtype', DTYPES.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nmodule.exports = validate;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive;\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar setReadOnlyAccessor = require( '@stdlib/utils-define-nonenumerable-read-only-accessor' );\nvar setReadWriteAccessor = require( '@stdlib/utils-define-nonenumerable-read-write-accessor' );\nvar constantFunction = require( '@stdlib/utils-constant-function' );\nvar noop = require( '@stdlib/utils-noop' );\nvar base = require( '@stdlib/random-base-uniform' );\nvar ctors = require( '@stdlib/array-typed-real-float-ctors' );\nvar filledBy = require( '@stdlib/array-base-filled-by' );\nvar nullary = require( '@stdlib/strided-base-nullary' );\nvar binary = require( '@stdlib/strided-base-binary' );\nvar format = require( '@stdlib/string-format' );\nvar defaults = require( './defaults.json' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution.\n*\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\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 {RangeError} `a` must be less than `b`\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 uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10 );\n* // returns \n*\n* @example\n* var uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nfunction factory() {\n\tvar options;\n\tvar nargs;\n\tvar opts;\n\tvar rand;\n\tvar prng;\n\tvar err;\n\n\topts = {\n\t\t'dtype': defaults.dtype\n\t};\n\n\tnargs = arguments.length;\n\tif ( nargs === 0 ) {\n\t\tprng = base;\n\t\trand = uniform2;\n\t} else if ( nargs === 1 ) {\n\t\toptions = arguments[ 0 ];\n\t\tprng = base.factory( options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform2;\n\t} else if ( nargs === 2 ) {\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ] );\n\t\trand = uniform1;\n\t} else if ( nargs === 3 ) {\n\t\toptions = arguments[ 2 ];\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ], options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform1;\n\t}\n\tif ( options && options.prng ) {\n\t\tsetReadOnly( rand, 'seed', null );\n\t\tsetReadOnly( rand, 'seedLength', null );\n\t\tsetReadWriteAccessor( rand, 'state', constantFunction( null ), noop );\n\t\tsetReadOnly( rand, 'stateLength', null );\n\t\tsetReadOnly( rand, 'byteLength', null );\n\t} else {\n\t\tsetReadOnlyAccessor( rand, 'seed', getSeed );\n\t\tsetReadOnlyAccessor( rand, 'seedLength', getSeedLength );\n\t\tsetReadWriteAccessor( rand, 'state', getState, setState );\n\t\tsetReadOnlyAccessor( rand, 'stateLength', getStateLength );\n\t\tsetReadOnlyAccessor( rand, 'byteLength', getStateSize );\n\t}\n\tsetReadOnly( rand, 'PRNG', prng.PRNG );\n\treturn rand;\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform1( len, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 1 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, prng );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tnullary( [ out ], [ len ], [ 1 ], prng );\n\t\treturn out;\n\t}\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {number} a - minimum support\n\t* @param {number} b - maximum support\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform2( len, a, b, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 3 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\t// NOTE: we could alternatively use the PRNG factory function to create a PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. Decision made here to avoid this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom number. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in a return value of `NaN`.\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, wrapper );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tbinary( [ [ a ], [ b ], out ], [ len ], [ 0, 0, 1 ], prng );\n\t\treturn out;\n\n\t\t/**\n\t\t* Applies parameters to a pseudorandom number generator function.\n\t\t*\n\t\t* @private\n\t\t* @returns {number} pseudorandom number\n\t\t*/\n\t\tfunction wrapper() {\n\t\t\treturn prng( a, b );\n\t\t}\n\t}\n\n\t/**\n\t* Returns the PRNG seed.\n\t*\n\t* @private\n\t* @returns {PRNGSeedMT19937} seed\n\t*/\n\tfunction getSeed() {\n\t\treturn rand.PRNG.seed;\n\t}\n\n\t/**\n\t* Returns the PRNG seed length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} seed length\n\t*/\n\tfunction getSeedLength() {\n\t\treturn rand.PRNG.seedLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state length\n\t*/\n\tfunction getStateLength() {\n\t\treturn rand.PRNG.stateLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state size (in bytes).\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state size (in bytes)\n\t*/\n\tfunction getStateSize() {\n\t\treturn rand.PRNG.byteLength;\n\t}\n\n\t/**\n\t* Returns the current pseudorandom number generator state.\n\t*\n\t* @private\n\t* @returns {PRNGStateMT19937} current state\n\t*/\n\tfunction getState() {\n\t\treturn rand.PRNG.state;\n\t}\n\n\t/**\n\t* Sets the pseudorandom number generator state.\n\t*\n\t* @private\n\t* @param {PRNGStateMT19937} s - generator state\n\t* @throws {Error} must provide a valid state\n\t*/\n\tfunction setState( s ) {\n\t\trand.PRNG.state = s;\n\t}\n}\n\n\n// EXPORTS //\n\nmodule.exports = factory;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @name uniform\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\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 = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar uniform = factory();\n\n\n// EXPORTS //\n\nmodule.exports = uniform;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @module @stdlib/random-array-uniform\n*\n* @example\n* var uniform = require( '@stdlib/random-array-uniform' );\n*\n* var arr = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var uniform = require( '@stdlib/random-array-uniform' );\n*\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* var uniform = require( '@stdlib/random-array-uniform' );\n*\n* var rand = uniform.factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* var uniform = require( '@stdlib/random-array-uniform' );\n*\n* var rand = uniform.factory( 2.0, 5.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\" }\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,GAAAC,EAAA,CAAAA,EAAA,SACC,MAAS,SACV,ICFA,IAAAC,EAAAC,EAAA,SAAAC,GAAAC,EAAA,cAsBA,IAAIC,EAAS,QAAS,uCAAwC,EAC1DC,EAAW,QAAS,gCAAiC,EACrDC,EAAa,QAAS,iCAAkC,EACxDC,EAAS,QAAS,uBAAwB,EAK1CC,EAASJ,EAAO,EACpBI,EAAO,KAAM,SAAU,EAwBvB,SAASC,EAAUC,EAAMC,EAAU,CAClC,OAAMN,EAAUM,CAAQ,EAGnBL,EAAYK,EAAS,OAAQ,IACjCD,EAAK,MAAQC,EAAQ,MAChBH,EAAO,QAASE,EAAK,KAAM,EAAI,GAC5B,IAAI,UAAWH,EAAQ,gFAAiF,QAASC,EAAO,KAAM,MAAO,EAAGE,EAAK,KAAM,CAAE,EAGvJ,KARC,IAAI,UAAWH,EAAQ,qEAAsEI,CAAQ,CAAE,CAShH,CAKAR,EAAO,QAAUM,ICvEjB,IAAAG,EAAAC,EAAA,SAAAC,GAAAC,EAAA,cAsBA,IAAIC,EAAuB,QAAS,uCAAwC,EAAE,YAC1EC,EAAc,QAAS,uDAAwD,EAC/EC,EAAsB,QAAS,uDAAwD,EACvFC,EAAuB,QAAS,wDAAyD,EACzFC,EAAmB,QAAS,iCAAkC,EAC9DC,EAAO,QAAS,oBAAqB,EACrCC,EAAO,QAAS,6BAA8B,EAC9CC,EAAQ,QAAS,sCAAuC,EACxDC,EAAW,QAAS,8BAA+B,EACnDC,EAAU,QAAS,8BAA+B,EAClDC,EAAS,QAAS,6BAA8B,EAChDC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IACXC,EAAW,IAwCf,SAASC,IAAU,CAClB,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EAOJ,GALAH,EAAO,CACN,MAASL,EAAS,KACnB,EAEAI,EAAQ,UAAU,OACbA,IAAU,EACdG,EAAOb,EACPY,EAAOG,UACIL,IAAU,EAAI,CAIzB,GAHAD,EAAU,UAAW,CAAE,EACvBI,EAAOb,EAAK,QAASS,CAAQ,EAC7BK,EAAMP,EAAUI,EAAMF,CAAQ,EACzBK,EACJ,MAAMA,EAEPF,EAAOG,CACR,SAAYL,IAAU,EACrBG,EAAOb,EAAK,QAAS,UAAW,CAAE,EAAG,UAAW,CAAE,CAAE,EACpDY,EAAOI,UACIN,IAAU,EAAI,CAIzB,GAHAD,EAAU,UAAW,CAAE,EACvBI,EAAOb,EAAK,QAAS,UAAW,CAAE,EAAG,UAAW,CAAE,EAAGS,CAAQ,EAC7DK,EAAMP,EAAUI,EAAMF,CAAQ,EACzBK,EACJ,MAAMA,EAEPF,EAAOI,CACR,CACA,OAAKP,GAAWA,EAAQ,MACvBd,EAAaiB,EAAM,OAAQ,IAAK,EAChCjB,EAAaiB,EAAM,aAAc,IAAK,EACtCf,EAAsBe,EAAM,QAASd,EAAkB,IAAK,EAAGC,CAAK,EACpEJ,EAAaiB,EAAM,cAAe,IAAK,EACvCjB,EAAaiB,EAAM,aAAc,IAAK,IAEtChB,EAAqBgB,EAAM,OAAQK,CAAQ,EAC3CrB,EAAqBgB,EAAM,aAAcM,CAAc,EACvDrB,EAAsBe,EAAM,QAASO,EAAUC,CAAS,EACxDxB,EAAqBgB,EAAM,cAAeS,CAAe,EACzDzB,EAAqBgB,EAAM,aAAcU,CAAa,GAEvD3B,EAAaiB,EAAM,OAAQC,EAAK,IAAK,EAC9BD,EAcP,SAASI,EAAUO,EAAKd,EAAU,CACjC,IAAIe,EACAC,EACAX,EACAY,EACAC,EACJ,GAAK,CAACjC,EAAsB6B,CAAI,EAC/B,MAAM,IAAI,UAAWlB,EAAQ,+EAAgFkB,CAAI,CAAE,EAGpH,GADAI,EAAI,CAAC,EACA,UAAU,OAAS,IACvBb,EAAMP,EAAUoB,EAAGlB,CAAQ,EACtBK,GACJ,MAAMA,EAIR,OADAY,EAAKC,EAAE,OAAShB,EAAK,MAChBe,IAAO,UACJxB,EAAUqB,EAAKV,CAAK,GAE5BW,EAAOvB,EAAOyB,CAAG,EACjBD,EAAM,IAAID,EAAMD,CAAI,EACpBpB,EAAS,CAAEsB,CAAI,EAAG,CAAEF,CAAI,EAAG,CAAE,CAAE,EAAGV,CAAK,EAChCY,EACR,CAgBA,SAASV,EAAUQ,EAAKK,EAAGC,EAAGpB,EAAU,CACvC,IAAIe,EACAC,EACAX,EACAY,EACAC,EACJ,GAAK,CAACjC,EAAsB6B,CAAI,EAC/B,MAAM,IAAI,UAAWlB,EAAQ,+EAAgFkB,CAAI,CAAE,EAGpH,GADAI,EAAI,CAAC,EACA,UAAU,OAAS,IACvBb,EAAMP,EAAUoB,EAAGlB,CAAQ,EACtBK,GACJ,MAAMA,EAKR,GADAY,EAAKC,EAAE,OAAShB,EAAK,MAChBe,IAAO,UACX,OAAOxB,EAAUqB,EAAKO,CAAQ,EAE/B,OAAAN,EAAOvB,EAAOyB,CAAG,EACjBD,EAAM,IAAID,EAAMD,CAAI,EACpBnB,EAAQ,CAAE,CAAEwB,CAAE,EAAG,CAAEC,CAAE,EAAGJ,CAAI,EAAG,CAAEF,CAAI,EAAG,CAAE,EAAG,EAAG,CAAE,EAAGV,CAAK,EACnDY,EAQP,SAASK,GAAU,CAClB,OAAOjB,EAAMe,EAAGC,CAAE,CACnB,CACD,CAQA,SAASZ,GAAU,CAClB,OAAOL,EAAK,KAAK,IAClB,CAQA,SAASM,GAAgB,CACxB,OAAON,EAAK,KAAK,UAClB,CAQA,SAASS,GAAiB,CACzB,OAAOT,EAAK,KAAK,WAClB,CAQA,SAASU,GAAe,CACvB,OAAOV,EAAK,KAAK,UAClB,CAQA,SAASO,GAAW,CACnB,OAAOP,EAAK,KAAK,KAClB,CASA,SAASQ,EAAUW,EAAI,CACtBnB,EAAK,KAAK,MAAQmB,CACnB,CACD,CAKAtC,EAAO,QAAUe,KCzRjB,IAAAwB,EAAAC,EAAA,SAAAC,GAAAC,EAAA,cAsBA,IAAIC,GAAU,IA8BVC,GAAUD,GAAQ,EAKtBD,EAAO,QAAUE,KCKjB,IAAIC,GAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,GAAU,IAKdF,GAAaC,EAAM,UAAWC,EAAQ,EAKtC,OAAO,QAAUD", - "names": ["require_defaults", "__commonJSMin", "exports", "module", "require_validate", "__commonJSMin", "exports", "module", "dtypes", "isObject", "hasOwnProp", "format", "DTYPES", "validate", "opts", "options", "require_factory", "__commonJSMin", "exports", "module", "isNonNegativeInteger", "setReadOnly", "setReadOnlyAccessor", "setReadWriteAccessor", "constantFunction", "noop", "base", "ctors", "filledBy", "nullary", "binary", "format", "defaults", "validate", "factory", "options", "nargs", "opts", "rand", "prng", "err", "uniform2", "uniform1", "getSeed", "getSeedLength", "getState", "setState", "getStateLength", "getStateSize", "len", "ctor", "out", "dt", "o", "a", "b", "wrapper", "s", "require_main", "__commonJSMin", "exports", "module", "factory", "uniform", "setReadOnly", "main", "factory"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 256216a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,169 +0,0 @@ - -{{alias}}( len, a, b[, options] ) - Returns an array containing pseudorandom numbers drawn from a continuous - uniform distribution. - - Parameters - ---------- - len: integer - Output array length. - - a: number - Minimum support. - - b: number - Maximum support. - - 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 ) - - - -{{alias}}.factory( [a, b, ][options] ) - Returns a function for creating arrays containing pseudorandom numbers drawn - from a continuous uniform distribution. - - If provided `a` and `b`, the returned function returns random variates drawn - from the specified distribution. - - If not provided `a` and `b`, the returned function requires that both `a` - and `b` 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. - - 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 ) - - - // Provide distribution parameters: - > fcn = {{alias}}.factory( 2.0, 5.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 ) - - - // Get a copy of the current state: - > var state = {{alias}}.state - - - > out = {{alias}}( 3, 2.0, 5.0 ) - - > out = {{alias}}( 3, 2.0, 5.0 ) - - - // Set the state: - > {{alias}}.state = state; - - // Regenerate a previous array: - > out = {{alias}}( 3, 2.0, 5.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 a087b98..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,355 +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. -*/ - -import random = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - random( 10, 2, 3 ); // $ExpectType RandomArray - random( 10, 1, 2 ); // $ExpectType RandomArray - random( 10, 1, 2, {} ); // $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 ); // $ExpectError - random( true, 2.0, 5.0 ); // $ExpectError - random( false, 2.0, 5.0 ); // $ExpectError - random( null, 2.0, 5.0 ); // $ExpectError - random( [], 2.0, 5.0 ); // $ExpectError - random( {}, 2.0, 5.0 ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - random( '5', 2.0, 5.0, {} ); // $ExpectError - random( true, 2.0, 5.0, {} ); // $ExpectError - random( false, 2.0, 5.0, {} ); // $ExpectError - random( null, 2.0, 5.0, {} ); // $ExpectError - random( [], 2.0, 5.0, {} ); // $ExpectError - random( {}, 2.0, 5.0, {} ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.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 ); // $ExpectError - random( 10, true, 5.0 ); // $ExpectError - random( 10, false, 5.0 ); // $ExpectError - random( 10, null, 5.0 ); // $ExpectError - random( 10, [], 5.0 ); // $ExpectError - random( 10, {}, 5.0 ); // $ExpectError - random( 10, ( x: number ): number => x, 5.0 ); // $ExpectError - - random( 10, '5', 5.0, {} ); // $ExpectError - random( 10, true, 5.0, {} ); // $ExpectError - random( 10, false, 5.0, {} ); // $ExpectError - random( 10, null, 5.0, {} ); // $ExpectError - random( 10, [], 5.0, {} ); // $ExpectError - random( 10, {}, 5.0, {} ); // $ExpectError - random( 10, ( x: number ): number => x, 5.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' ); // $ExpectError - random( 10, 2.0, true ); // $ExpectError - random( 10, 2.0, false ); // $ExpectError - random( 10, 2.0, null ); // $ExpectError - random( 10, 2.0, [] ); // $ExpectError - random( 10, 2.0, {} ); // $ExpectError - random( 10, 2.0, ( x: number ): number => x ); // $ExpectError - - random( 10, 2.0, '5', {} ); // $ExpectError - random( 10, 2.0, true, {} ); // $ExpectError - random( 10, 2.0, false, {} ); // $ExpectError - random( 10, 2.0, null, {} ); // $ExpectError - random( 10, 2.0, [], {} ); // $ExpectError - random( 10, 2.0, {}, {} ); // $ExpectError - random( 10, 2.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, '5' ); // $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, [] ); // $ExpectError - random( 10, 2.0, 5.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, { 'dtype': 123 } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': null } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - random( 10, 2.0, 5.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 -} - -// Attached to main export is a `factory` method which returns a function... -{ - random.factory( 2.0, 5.0 ); // $ExpectType UnaryFunction - random.factory( 2.0, 5.0, { 'copy': false } ); // $ExpectType UnaryFunction - - random.factory(); // $ExpectType TernaryFunction - random.factory( { 'copy': false } ); // $ExpectType TernaryFunction -} - -// The `factory` method returns a function which returns an array... -{ - const fcn1 = random.factory( 2.0, 5.0 ); - fcn1( 10 ); // $ExpectType RandomArray - - const fcn2 = random.factory(); - fcn2( 10, 2.0, 5.0 ); // $ExpectType RandomArray -} - -// The compiler throws an error if the `factory` method is provided invalid arguments... -{ - random.factory( '5', 5.0 ); // $ExpectError - random.factory( true, 5.0 ); // $ExpectError - random.factory( false, 5.0 ); // $ExpectError - random.factory( [], 5.0 ); // $ExpectError - random.factory( {}, 5.0 ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0 ); // $ExpectError - - random.factory( '5', 5.0, {} ); // $ExpectError - random.factory( true, 5.0, {} ); // $ExpectError - random.factory( false, 5.0, {} ); // $ExpectError - random.factory( [], 5.0, {} ); // $ExpectError - random.factory( {}, 5.0, {} ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0, {} ); // $ExpectError - - random.factory( 2.0, '5' ); // $ExpectError - random.factory( 2.0, true ); // $ExpectError - random.factory( 2.0, false ); // $ExpectError - random.factory( 2.0, [] ); // $ExpectError - random.factory( 2.0, {} ); // $ExpectError - random.factory( 2.0, ( x: number ): number => x ); // $ExpectError - - random.factory( 2.0, '5', {} ); // $ExpectError - random.factory( 2.0, true, {} ); // $ExpectError - random.factory( 2.0, false, {} ); // $ExpectError - random.factory( 2.0, [], {} ); // $ExpectError - random.factory( 2.0, {}, {} ); // $ExpectError - random.factory( 2.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, 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, { 'prng': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'seed': true } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': [ 'a' ] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'state': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': {} } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': true ); // $ExpectError - random.factory( 2.0, 5.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, { 'copy': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'dtype': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - random.factory( 2.0, 5.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, {}, {} ); // $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 ); - 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 ); // $ExpectError - fcn2( false, 2.0, 5.0 ); // $ExpectError - fcn2( '5', 2.0, 5.0 ); // $ExpectError - fcn2( [], 2.0, 5.0 ); // $ExpectError - fcn2( {}, 2.0, 5.0 ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - fcn2( true, 2.0, 5.0, {} ); // $ExpectError - fcn2( false, 2.0, 5.0, {} ); // $ExpectError - fcn2( '5', 2.0, 5.0, {} ); // $ExpectError - fcn2( [], 2.0, 5.0, {} ); // $ExpectError - fcn2( {}, 2.0, 5.0, {} ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0, {} ); // $ExpectError - - fcn2( 10, true, 5.0 ); // $ExpectError - fcn2( 10, false, 5.0 ); // $ExpectError - fcn2( 10, '5', 5.0 ); // $ExpectError - fcn2( 10, [], 5.0 ); // $ExpectError - fcn2( 10, {}, 5.0 ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0 ); // $ExpectError - - fcn2( 10, true, 5.0, {} ); // $ExpectError - fcn2( 10, false, 5.0, {} ); // $ExpectError - fcn2( 10, '5', 5.0, {} ); // $ExpectError - fcn2( 10, [], 5.0, {} ); // $ExpectError - fcn2( 10, {}, 5.0, {} ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0, {} ); // $ExpectError - - fcn2( 10, 2.0, true ); // $ExpectError - fcn2( 10, 2.0, false ); // $ExpectError - fcn2( 10, 2.0, '5' ); // $ExpectError - fcn2( 10, 2.0, [] ); // $ExpectError - fcn2( 10, 2.0, {} ); // $ExpectError - fcn2( 10, 2.0, ( x: number ): number => x ); // $ExpectError - - fcn2( 10, 2.0, true, {} ); // $ExpectError - fcn2( 10, 2.0, false, {} ); // $ExpectError - fcn2( 10, 2.0, '5', {} ); // $ExpectError - fcn2( 10, 2.0, [], {} ); // $ExpectError - fcn2( 10, 2.0, {}, {} ); // $ExpectError - fcn2( 10, 2.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, { 'dtype': 123 } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': null } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError - - const fcn2 = random.factory( 2.0, 5.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 ); - fcn1(); // $ExpectError - fcn1( 1, 1, 1 ); // $ExpectError - - const fcn2 = random.factory(); - fcn2(); // $ExpectError - fcn2( 1 ); // $ExpectError - fcn2( 1, 1, 1, 1 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index c485546..0000000 --- a/examples/index.js +++ /dev/null @@ -1,48 +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'; - -var logEach = require( '@stdlib/console-log-each' ); -var uniform = require( './../lib' ); - -// Create a function for generating random arrays originating from the same state: -var random = uniform.factory( 2.0, 5.0, { - 'state': uniform.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 = uniform.factory( 2.0, 5.0, { - 'state': uniform.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 6fef7d9..e49ce72 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { FloatDataType, 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..411d38d --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.1.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-accessor@v0.1.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-write-accessor@v0.1.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-constant-function@v0.1.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-noop@v0.1.1-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/random-base-uniform@v0.1.0-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-typed-real-float-ctors@v0.1.0-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@v0.1.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-nullary@v0.1.0-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@v0.1.0-esm/index.mjs";import f from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.1.1-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/array-typed-real-float-dtypes@v0.1.1-esm/index.mjs";import h from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.1.0-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.1.1-esm/index.mjs";var c="float64",u=a();function g(e,t){return h(t)?j(t,"dtype")&&(e.dtype=t.dtype,u.indexOf(e.dtype)<0)?new TypeError(f("1eR2X,3g,4S,GD,Gg,Jm","dtype",u.join('", "'),e.dtype)):null:new TypeError(f("1eR2V,FD",t))}function v(){var a,h,j,u,v,y;if(j={dtype:c},0===(h=arguments.length))v=d,u=x;else if(1===h){if(a=arguments[0],v=d.factory(a),y=g(j,a))throw y;u=x}else if(2===h)v=d.factory(arguments[0],arguments[1]),u=b;else if(3===h){if(a=arguments[2],v=d.factory(arguments[0],arguments[1],a),y=g(j,a))throw y;u=b}return a&&a.prng?(e(u,"seed",null),e(u,"seedLength",null),n(u,"state",r(null),i),e(u,"stateLength",null),e(u,"byteLength",null)):(s(u,"seed",w),s(u,"seedLength",G),n(u,"state",N,P),s(u,"stateLength",R),s(u,"byteLength",L)),e(u,"PRNG",v.PRNG),u;function b(e,s){var n,r,i,d;if(!t(e))throw new TypeError(f("1eR2d,MG",e));if(d={},arguments.length>1&&(r=g(d,s)))throw r;return"generic"===(i=d.dtype||j.dtype)?l(e,v):(n=new(o(i))(e),m([n],[e],[1],v),n)}function x(e,s,n,r){var i,d,m,a;if(!t(e))throw new TypeError(f("1eR2d,MG",e));if(a={},arguments.length>3&&(d=g(a,r)))throw d;return"generic"===(m=a.dtype||j.dtype)?l(e,h):(i=new(o(m))(e),p([[s],[n],i],[e],[0,0,1],v),i);function h(){return v(s,n)}}function w(){return u.PRNG.seed}function G(){return u.PRNG.seedLength}function R(){return u.PRNG.stateLength}function L(){return u.PRNG.byteLength}function N(){return u.PRNG.state}function P(e){u.PRNG.state=e}}u.push("generic");var y=v();e(y,"factory",v);export{y as default,v as factory}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..f442194 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/factory.js","../lib/main.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 dtypes from '@stdlib/array-typed-real-float-dtypes';\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes();\nDTYPES.push( 'generic' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '1eR2V,FD', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( DTYPES.indexOf( opts.dtype ) < 0 ) {\n\t\t\treturn new TypeError( format( '1eR2X,3g,4S,GD,Gg,Jm', 'dtype', DTYPES.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport setReadOnlyAccessor from '@stdlib/utils-define-nonenumerable-read-only-accessor';\nimport setReadWriteAccessor from '@stdlib/utils-define-nonenumerable-read-write-accessor';\nimport constantFunction from '@stdlib/utils-constant-function';\nimport noop from '@stdlib/utils-noop';\nimport base from '@stdlib/random-base-uniform';\nimport ctors from '@stdlib/array-typed-real-float-ctors';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport nullary from '@stdlib/strided-base-nullary';\nimport binary from '@stdlib/strided-base-binary';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution.\n*\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\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 {RangeError} `a` must be less than `b`\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 uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10 );\n* // returns \n*\n* @example\n* var uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nfunction factory() {\n\tvar options;\n\tvar nargs;\n\tvar opts;\n\tvar rand;\n\tvar prng;\n\tvar err;\n\n\topts = {\n\t\t'dtype': defaults.dtype\n\t};\n\n\tnargs = arguments.length;\n\tif ( nargs === 0 ) {\n\t\tprng = base;\n\t\trand = uniform2;\n\t} else if ( nargs === 1 ) {\n\t\toptions = arguments[ 0 ];\n\t\tprng = base.factory( options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform2;\n\t} else if ( nargs === 2 ) {\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ] );\n\t\trand = uniform1;\n\t} else if ( nargs === 3 ) {\n\t\toptions = arguments[ 2 ];\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ], options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform1;\n\t}\n\tif ( options && options.prng ) {\n\t\tsetReadOnly( rand, 'seed', null );\n\t\tsetReadOnly( rand, 'seedLength', null );\n\t\tsetReadWriteAccessor( rand, 'state', constantFunction( null ), noop );\n\t\tsetReadOnly( rand, 'stateLength', null );\n\t\tsetReadOnly( rand, 'byteLength', null );\n\t} else {\n\t\tsetReadOnlyAccessor( rand, 'seed', getSeed );\n\t\tsetReadOnlyAccessor( rand, 'seedLength', getSeedLength );\n\t\tsetReadWriteAccessor( rand, 'state', getState, setState );\n\t\tsetReadOnlyAccessor( rand, 'stateLength', getStateLength );\n\t\tsetReadOnlyAccessor( rand, 'byteLength', getStateSize );\n\t}\n\tsetReadOnly( rand, 'PRNG', prng.PRNG );\n\treturn rand;\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform1( len, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( '1eR2d,MG', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 1 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, prng );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tnullary( [ out ], [ len ], [ 1 ], prng );\n\t\treturn out;\n\t}\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {number} a - minimum support\n\t* @param {number} b - maximum support\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform2( len, a, b, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( '1eR2d,MG', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 3 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\t// NOTE: we could alternatively use the PRNG factory function to create a PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. Decision made here to avoid this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom number. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in a return value of `NaN`.\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, wrapper );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tbinary( [ [ a ], [ b ], out ], [ len ], [ 0, 0, 1 ], prng );\n\t\treturn out;\n\n\t\t/**\n\t\t* Applies parameters to a pseudorandom number generator function.\n\t\t*\n\t\t* @private\n\t\t* @returns {number} pseudorandom number\n\t\t*/\n\t\tfunction wrapper() {\n\t\t\treturn prng( a, b );\n\t\t}\n\t}\n\n\t/**\n\t* Returns the PRNG seed.\n\t*\n\t* @private\n\t* @returns {PRNGSeedMT19937} seed\n\t*/\n\tfunction getSeed() {\n\t\treturn rand.PRNG.seed;\n\t}\n\n\t/**\n\t* Returns the PRNG seed length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} seed length\n\t*/\n\tfunction getSeedLength() {\n\t\treturn rand.PRNG.seedLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state length\n\t*/\n\tfunction getStateLength() {\n\t\treturn rand.PRNG.stateLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state size (in bytes).\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state size (in bytes)\n\t*/\n\tfunction getStateSize() {\n\t\treturn rand.PRNG.byteLength;\n\t}\n\n\t/**\n\t* Returns the current pseudorandom number generator state.\n\t*\n\t* @private\n\t* @returns {PRNGStateMT19937} current state\n\t*/\n\tfunction getState() {\n\t\treturn rand.PRNG.state;\n\t}\n\n\t/**\n\t* Sets the pseudorandom number generator state.\n\t*\n\t* @private\n\t* @param {PRNGStateMT19937} s - generator state\n\t* @throws {Error} must provide a valid state\n\t*/\n\tfunction setState( s ) {\n\t\trand.PRNG.state = s;\n\t}\n}\n\n\n// EXPORTS //\n\nexport default factory;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @name uniform\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\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 = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar uniform = factory();\n\n\n// EXPORTS //\n\nexport default uniform;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @module @stdlib/random-array-uniform\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.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\" }\n"],"names":["DTYPES","dtypes","validate","opts","options","isObject","hasOwnProp","dtype","indexOf","TypeError","format","join","factory","nargs","rand","prng","err","defaults","arguments","length","base","uniform2","uniform1","setReadOnly","setReadWriteAccessor","constantFunction","noop","setReadOnlyAccessor","getSeed","getSeedLength","getState","setState","getStateLength","getStateSize","PRNG","len","out","dt","o","isNonNegativeInteger","filledBy","ctors","nullary","a","b","wrapper","binary","seed","seedLength","stateLength","byteLength","state","s","push","uniform","main"],"mappings":";;ohDA8BIA,EAASC,IAyBb,SAASC,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,WACzBD,EAAKI,MAAQH,EAAQG,MAChBP,EAAOQ,QAASL,EAAKI,OAAU,GAC5B,IAAIE,UAAWC,EAAQ,uBAAwB,QAASV,EAAOW,KAAM,QAAUR,EAAKI,QAGtF,KARC,IAAIE,UAAWC,EAAQ,WAAYN,GAS5C,CCSA,SAASQ,IACR,IAAIR,EACAS,EACAV,EACAW,EACAC,EACAC,EAOJ,GALAb,EAAO,CACNI,MAASU,GAIK,KADfJ,EAAQK,UAAUC,QAEjBJ,EAAOK,EACPN,EAAOO,OACD,GAAe,IAAVR,EAAc,CAIzB,GAHAT,EAAUc,UAAW,GACrBH,EAAOK,EAAKR,QAASR,GACrBY,EAAMd,EAAUC,EAAMC,GAErB,MAAMY,EAEPF,EAAOO,CACT,MAAQ,GAAe,IAAVR,EACXE,EAAOK,EAAKR,QAASM,UAAW,GAAKA,UAAW,IAChDJ,EAAOQ,OACD,GAAe,IAAVT,EAAc,CAIzB,GAHAT,EAAUc,UAAW,GACrBH,EAAOK,EAAKR,QAASM,UAAW,GAAKA,UAAW,GAAKd,GACrDY,EAAMd,EAAUC,EAAMC,GAErB,MAAMY,EAEPF,EAAOQ,CACP,CAeD,OAdKlB,GAAWA,EAAQW,MACvBQ,EAAaT,EAAM,OAAQ,MAC3BS,EAAaT,EAAM,aAAc,MACjCU,EAAsBV,EAAM,QAASW,EAAkB,MAAQC,GAC/DH,EAAaT,EAAM,cAAe,MAClCS,EAAaT,EAAM,aAAc,QAEjCa,EAAqBb,EAAM,OAAQc,GACnCD,EAAqBb,EAAM,aAAce,GACzCL,EAAsBV,EAAM,QAASgB,EAAUC,GAC/CJ,EAAqBb,EAAM,cAAekB,GAC1CL,EAAqBb,EAAM,aAAcmB,IAE1CV,EAAaT,EAAM,OAAQC,EAAKmB,MACzBpB,EAcP,SAASQ,EAAUa,EAAK/B,GACvB,IACIgC,EACApB,EACAqB,EACAC,EACJ,IAAMC,EAAsBJ,GAC3B,MAAM,IAAI1B,UAAWC,EAAQ,WAAYyB,IAG1C,GADAG,EAAI,CAAA,EACCpB,UAAUC,OAAS,IACvBH,EAAMd,EAAUoC,EAAGlC,IAElB,MAAMY,EAIR,MAAY,aADZqB,EAAKC,EAAE/B,OAASJ,EAAKI,OAEbiC,EAAUL,EAAKpB,IAGvBqB,EAAM,IADCK,EAAOJ,GACR,CAAUF,GAChBO,EAAS,CAAEN,GAAO,CAAED,GAAO,CAAE,GAAKpB,GAC3BqB,EACP,CAgBD,SAASf,EAAUc,EAAKQ,EAAGC,EAAGxC,GAC7B,IACIgC,EACApB,EACAqB,EACAC,EACJ,IAAMC,EAAsBJ,GAC3B,MAAM,IAAI1B,UAAWC,EAAQ,WAAYyB,IAG1C,GADAG,EAAI,CAAA,EACCpB,UAAUC,OAAS,IACvBH,EAAMd,EAAUoC,EAAGlC,IAElB,MAAMY,EAKR,MAAY,aADZqB,EAAKC,EAAE/B,OAASJ,EAAKI,OAEbiC,EAAUL,EAAKU,IAGvBT,EAAM,IADCK,EAAOJ,GACR,CAAUF,GAChBW,EAAQ,CAAE,CAAEH,GAAK,CAAEC,GAAKR,GAAO,CAAED,GAAO,CAAE,EAAG,EAAG,GAAKpB,GAC9CqB,GAQP,SAASS,IACR,OAAO9B,EAAM4B,EAAGC,EAChB,CACD,CAQD,SAAShB,IACR,OAAOd,EAAKoB,KAAKa,IACjB,CAQD,SAASlB,IACR,OAAOf,EAAKoB,KAAKc,UACjB,CAQD,SAAShB,IACR,OAAOlB,EAAKoB,KAAKe,WACjB,CAQD,SAAShB,IACR,OAAOnB,EAAKoB,KAAKgB,UACjB,CAQD,SAASpB,IACR,OAAOhB,EAAKoB,KAAKiB,KACjB,CASD,SAASpB,EAAUqB,GAClBtC,EAAKoB,KAAKiB,MAAQC,CAClB,CACF,CDrPApD,EAAOqD,KAAM,WEqBV,IAACC,EAAU1C,ICiBdW,EAAAgC,EAAA,UAAA3C"} \ No newline at end of file diff --git a/lib/defaults.json b/lib/defaults.json deleted file mode 100644 index 83f4438..0000000 --- a/lib/defaults.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "dtype": "float64" -} diff --git a/lib/factory.js b/lib/factory.js deleted file mode 100644 index 24d5d10..0000000 --- a/lib/factory.js +++ /dev/null @@ -1,282 +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 isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var setReadOnlyAccessor = require( '@stdlib/utils-define-nonenumerable-read-only-accessor' ); -var setReadWriteAccessor = require( '@stdlib/utils-define-nonenumerable-read-write-accessor' ); -var constantFunction = require( '@stdlib/utils-constant-function' ); -var noop = require( '@stdlib/utils-noop' ); -var base = require( '@stdlib/random-base-uniform' ); -var ctors = require( '@stdlib/array-typed-real-float-ctors' ); -var filledBy = require( '@stdlib/array-base-filled-by' ); -var nullary = require( '@stdlib/strided-base-nullary' ); -var binary = require( '@stdlib/strided-base-binary' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution. -* -* @param {number} [a] - minimum support -* @param {number} [b] - maximum support -* @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 {RangeError} `a` must be less than `b` -* @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 uniform = factory( 2.0, 5.0 ); -* // returns -* -* var arr = uniform( 10 ); -* // returns -* -* @example -* var uniform = factory( 2.0, 5.0 ); -* // returns -* -* var arr = uniform( 10, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -function factory() { - var options; - var nargs; - var opts; - var rand; - var prng; - var err; - - opts = { - 'dtype': defaults.dtype - }; - - nargs = arguments.length; - if ( nargs === 0 ) { - prng = base; - rand = uniform2; - } else if ( nargs === 1 ) { - options = arguments[ 0 ]; - prng = base.factory( options ); - err = validate( opts, options ); - if ( err ) { - throw err; - } - rand = uniform2; - } else if ( nargs === 2 ) { - prng = base.factory( arguments[ 0 ], arguments[ 1 ] ); - rand = uniform1; - } else if ( nargs === 3 ) { - options = arguments[ 2 ]; - prng = base.factory( arguments[ 0 ], arguments[ 1 ], options ); - err = validate( opts, options ); - if ( err ) { - throw err; - } - rand = uniform1; - } - if ( options && options.prng ) { - setReadOnly( rand, 'seed', null ); - setReadOnly( rand, 'seedLength', null ); - setReadWriteAccessor( rand, 'state', constantFunction( null ), noop ); - setReadOnly( rand, 'stateLength', null ); - setReadOnly( rand, 'byteLength', null ); - } else { - setReadOnlyAccessor( rand, 'seed', getSeed ); - setReadOnlyAccessor( rand, 'seedLength', getSeedLength ); - setReadWriteAccessor( rand, 'state', getState, setState ); - setReadOnlyAccessor( rand, 'stateLength', getStateLength ); - setReadOnlyAccessor( rand, 'byteLength', getStateSize ); - } - setReadOnly( rand, 'PRNG', prng.PRNG ); - return rand; - - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @private - * @param {NonNegativeInteger} len - array length - * @param {Options} [options] - function options - * @param {string} [options.dtype] - 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 - */ - function uniform1( len, options ) { - var ctor; - var out; - var err; - var dt; - var o; - if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( '1eR2d,MG', len ) ); - } - o = {}; - if ( arguments.length > 1 ) { - err = validate( o, options ); - if ( err ) { - throw err; - } - } - dt = o.dtype || opts.dtype; - if ( dt === 'generic' ) { - return filledBy( len, prng ); - } - ctor = ctors( dt ); - out = new ctor( len ); - nullary( [ out ], [ len ], [ 1 ], prng ); - return out; - } - - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @private - * @param {NonNegativeInteger} len - array length - * @param {number} a - minimum support - * @param {number} b - maximum support - * @param {Options} [options] - function options - * @param {string} [options.dtype] - 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 - */ - function uniform2( len, a, b, options ) { - var ctor; - var out; - var err; - var dt; - var o; - if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( '1eR2d,MG', len ) ); - } - o = {}; - if ( arguments.length > 3 ) { - err = validate( o, options ); - if ( err ) { - throw err; - } - } - // NOTE: we could alternatively use the PRNG factory function to create a PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. Decision made here to avoid this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom number. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in a return value of `NaN`. - dt = o.dtype || opts.dtype; - if ( dt === 'generic' ) { - return filledBy( len, wrapper ); - } - ctor = ctors( dt ); - out = new ctor( len ); - binary( [ [ a ], [ b ], out ], [ len ], [ 0, 0, 1 ], prng ); - return out; - - /** - * Applies parameters to a pseudorandom number generator function. - * - * @private - * @returns {number} pseudorandom number - */ - function wrapper() { - return prng( a, b ); - } - } - - /** - * Returns the PRNG seed. - * - * @private - * @returns {PRNGSeedMT19937} seed - */ - function getSeed() { - return rand.PRNG.seed; - } - - /** - * Returns the PRNG seed length. - * - * @private - * @returns {PositiveInteger} seed length - */ - function getSeedLength() { - return rand.PRNG.seedLength; - } - - /** - * Returns the PRNG state length. - * - * @private - * @returns {PositiveInteger} state length - */ - function getStateLength() { - return rand.PRNG.stateLength; - } - - /** - * Returns the PRNG state size (in bytes). - * - * @private - * @returns {PositiveInteger} state size (in bytes) - */ - function getStateSize() { - return rand.PRNG.byteLength; - } - - /** - * Returns the current pseudorandom number generator state. - * - * @private - * @returns {PRNGStateMT19937} current state - */ - function getState() { - return rand.PRNG.state; - } - - /** - * Sets the pseudorandom number generator state. - * - * @private - * @param {PRNGStateMT19937} s - generator state - * @throws {Error} must provide a valid state - */ - function setState( s ) { - rand.PRNG.state = s; - } -} - - -// EXPORTS // - -module.exports = factory; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 0077f00..0000000 --- a/lib/index.js +++ /dev/null @@ -1,77 +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'; - -/** -* Create an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. -* -* @module @stdlib/random-array-uniform -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var arr = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var arr = uniform( 10, 2.0, 5.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var rand = uniform.factory( 2.0, 5.0 ); -* // returns -* -* var arr = rand( 10 ); -* // returns -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var rand = uniform.factory( 2.0, 5.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" } diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index da0d9b1..0000000 --- a/lib/main.js +++ /dev/null @@ -1,58 +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 factory = require( './factory.js' ); - - -// MAIN // - -/** -* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. -* -* @name uniform -* @type {Function} -* @param {NonNegativeInteger} len - array length -* @param {number} a - minimum support -* @param {number} b - maximum support -* @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 = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var arr = uniform( 10, 2.0, 5.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -var uniform = factory(); - - -// EXPORTS // - -module.exports = uniform; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index 1c3d511..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,72 +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 dtypes = require( '@stdlib/array-typed-real-float-dtypes' ); -var isObject = require( '@stdlib/assert-is-plain-object' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// VARIABLES // - -var DTYPES = dtypes(); -DTYPES.push( 'generic' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Options} options - function options -* @param {string} [options.dtype] - output array data type -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var options = { -* 'dtype': 'float64' -* }; -* var err = validate( opts, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( '1eR2V,FD', options ) ); - } - if ( hasOwnProp( options, 'dtype' ) ) { - opts.dtype = options.dtype; - if ( DTYPES.indexOf( opts.dtype ) < 0 ) { - return new TypeError( format( '1eR2X,3g,4S,GD,Gg,Jm', 'dtype', DTYPES.join( '", "' ), opts.dtype ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index 74bcead..767a213 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 continuous uniform 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,55 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-filled-by": "^0.1.0", - "@stdlib/array-typed-real-float-ctors": "^0.1.0", - "@stdlib/array-typed-real-float-dtypes": "^0.1.1", - "@stdlib/assert-has-own-property": "^0.1.1", - "@stdlib/assert-is-nonnegative-integer": "^0.1.0", - "@stdlib/assert-is-plain-object": "^0.1.1", - "@stdlib/random-base-uniform": "^0.1.0", - "@stdlib/strided-base-binary": "^0.1.0", - "@stdlib/strided-base-nullary": "^0.1.0", - "@stdlib/error-tools-fmtprodmsg": "^0.1.1", - "@stdlib/types": "^0.1.0", - "@stdlib/utils-constant-function": "^0.1.1", - "@stdlib/utils-define-nonenumerable-read-only-accessor": "^0.1.1", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1", - "@stdlib/utils-define-nonenumerable-read-write-accessor": "^0.1.1", - "@stdlib/utils-noop": "^0.1.1" - }, - "devDependencies": { - "@stdlib/array-float32": "^0.1.1", - "@stdlib/array-float64": "^0.1.1", - "@stdlib/array-uint32": "^0.1.1", - "@stdlib/assert-is-uint32array": "^0.1.1", - "@stdlib/bench": "^0.1.0", - "@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" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdmath", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..a3dae90 --- /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.factory.js b/test/test.factory.js deleted file mode 100644 index a869e75..0000000 --- a/test/test.factory.js +++ /dev/null @@ -1,1328 +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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -tape( 'the function throws an error if the second distribution parameter is less than the first distribution parameter', function test( t ) { - var values; - var i; - - values = [ - [ 0.0, 0.0 ], - [ -2.0, -4.0 ], - [ 2.0, 1.0 ] - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( arr ) { - return function badValue() { - factory( arr[0], arr[1] ); - }; - } -}); - -tape( 'the function throws an error if the second distribution parameter is less than the first distribution parameter (options)', function test( t ) { - var values; - var i; - - values = [ - [ 0.0, 0.0 ], - [ -2.0, -4.0 ], - [ 2.0, 1.0 ] - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( arr ) { - return function badValue() { - factory( arr[0], arr[1], {} ); - }; - } -}); - -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, 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, { - '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, { - '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, { - '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, { - '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, { - '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, { - '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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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 ); - - 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 ); - - 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, { - '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 ); - - 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 ); - 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( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory(); - actual = random( 10, 2.0, 5.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( typeof actual[ i ], 'number', '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 ); - - 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 ); - - 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 ); - - 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 that generates `NaN` values if the first distribution parameter is greater than or equal to the second distribution parameter', function test( t ) { - var random; - var values; - var actual; - var i; - var j; - - random = factory(); - values = [ - [ 2.0, 1.0 ], - [ -3.0, -4.0 ], - [ 0.0, 0.0 ] - ]; - - for ( i = 0; i < values.length; i++ ) { - actual = random( 10, values[ i ][ 0 ], values[ i ][ 1 ] ); - for ( j = 0; j < actual.length; j++ ) { - t.strictEqual( isnan( actual[ j ] ), true, 'returns expected value when provided '+values[ 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, { - '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 ); - - 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, { - '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( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'float64' - }); - actual = random( 10, 2.0, 5.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( typeof actual[ i ], 'number', '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, { - '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( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'float32' - }); - actual = random( 10, 2.0, 5.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( typeof actual[ i ], 'number', '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, { - '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 ); - - 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, { - '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, { - '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 ); - - // 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, { - '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 ); - - // 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, { - '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 ); - - 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, { - 'prng': randu.normalized - }); - - randu = minstd.factory({ - 'seed': seed - }); - random2 = factory( 2.0, 5.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 ); - arr2 = random2( 10, 2.0, 5.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 c4fb6d3..0000000 --- a/test/test.js +++ /dev/null @@ -1,69 +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 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 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 37b0080..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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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, 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, { - '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 ); - - 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( typeof actual[ i ], 'number', '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, { - '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( typeof actual[ i ], 'number', '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, { - '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( typeof actual[ i ], 'number', '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, { - '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 ); - } - // Capture the current state: - state = random.state; - - // Move to a future state... - arr = random( 10, 2.0, 5.0 ); - for ( i = 0; i < 100; i++ ) { - random( 2, 2.0, 5.0 ); - } - // Set the state: - random.state = state; - - // Replay previously generated values: - t.deepEqual( random( 10, 2.0, 5.0 ), arr, 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.validate.js b/test/test.validate.js deleted file mode 100644 index 9fbe15f..0000000 --- a/test/test.validate.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 validate = require( './../lib/validate.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof validate, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function returns an error if provided an options argument which is not an object', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - void 0, - null, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, values[ i ] ); - t.equal( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided a `dtype` option which is not a supported data type', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - -5, - NaN, - true, - false, - void 0, - null, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, { - 'dtype': values[ i ] - }); - t.equal( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns null if all options are valid', function test( t ) { - var options; - var opts; - var err; - - options = { - 'dtype': 'float64' - }; - opts = {}; - err = validate( opts, options ); - - t.equal( err, null, 'returns null' ); - t.deepEqual( opts, options, 'sets option values' ); - - t.end(); -}); - -tape( 'the function ignores unrecognized/unsupported options', function test( t ) { - var options; - var opts; - var err; - - options = { - 'beep': true, - 'boop': 'bop' - }; - opts = {}; - err = validate( opts, options ); - - t.equal( err, null, 'returns null' ); - t.deepEqual( opts, {}, 'does not set any option values' ); - t.end(); -}); From a253714af698d147fe1ea6ceea67c07707a37627 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 1 Dec 2023 15:14:02 +0000 Subject: [PATCH 40/82] Transform error messages --- lib/factory.js | 6 +++--- lib/validate.js | 6 +++--- package.json | 2 +- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/lib/factory.js b/lib/factory.js index 22ec236..24d5d10 100644 --- a/lib/factory.js +++ b/lib/factory.js @@ -31,7 +31,7 @@ var ctors = require( '@stdlib/array-typed-real-float-ctors' ); var filledBy = require( '@stdlib/array-base-filled-by' ); var nullary = require( '@stdlib/strided-base-nullary' ); var binary = require( '@stdlib/strided-base-binary' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -144,7 +144,7 @@ function factory() { var dt; var o; if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) ); + throw new TypeError( format( '1eR2d,MG', len ) ); } o = {}; if ( arguments.length > 1 ) { @@ -184,7 +184,7 @@ function factory() { var dt; var o; if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) ); + throw new TypeError( format( '1eR2d,MG', len ) ); } o = {}; if ( arguments.length > 3 ) { diff --git a/lib/validate.js b/lib/validate.js index 40b9723..1c3d511 100644 --- a/lib/validate.js +++ b/lib/validate.js @@ -23,7 +23,7 @@ var dtypes = require( '@stdlib/array-typed-real-float-dtypes' ); var isObject = require( '@stdlib/assert-is-plain-object' ); var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // VARIABLES // @@ -55,12 +55,12 @@ DTYPES.push( 'generic' ); */ function validate( opts, options ) { if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); + return new TypeError( format( '1eR2V,FD', options ) ); } if ( hasOwnProp( options, 'dtype' ) ) { opts.dtype = options.dtype; if ( DTYPES.indexOf( opts.dtype ) < 0 ) { - return new TypeError( format( 'invalid option. `%s` option must be one of the following: "%s". Option: `%s`.', 'dtype', DTYPES.join( '", "' ), opts.dtype ) ); + return new TypeError( format( '1eR2X,3g,4S,GD,Gg,Jm', 'dtype', DTYPES.join( '", "' ), opts.dtype ) ); } } return null; diff --git a/package.json b/package.json index f38cc33..0b325cb 100644 --- a/package.json +++ b/package.json @@ -46,7 +46,7 @@ "@stdlib/random-base-uniform": "^0.1.0", "@stdlib/strided-base-binary": "^0.1.0", "@stdlib/strided-base-nullary": "^0.1.0", - "@stdlib/string-format": "^0.1.1", + "@stdlib/error-tools-fmtprodmsg": "^0.1.1", "@stdlib/types": "^0.2.0", "@stdlib/utils-constant-function": "^0.1.1", "@stdlib/utils-define-nonenumerable-read-only-accessor": "^0.1.1", From 71f863f839564992fc9342d1362739accc86cd71 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 2 Dec 2023 14:17:56 +0000 Subject: [PATCH 41/82] Remove files --- index.d.ts | 245 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6427 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 e49ce72..0000000 --- a/index.d.ts +++ /dev/null @@ -1,245 +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. -*/ - -// TypeScript Version: 4.1 - -/// - -import { FloatDataType, FloatTypedArray } from '@stdlib/types/array'; -import * as random from '@stdlib/types/random'; - -/** -* Supported data types. -*/ -type DataType = FloatDataType | 'generic'; - -/** -* 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 continuous uniform distribution with pre-specified parameter values. -*/ -interface UnaryFunction extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @param len - array length - * @param options - function options - * @returns output array - */ - ( len: number, options?: Options ): RandomArray; -} - -/** -* Interface for generating pseudorandom numbers drawn from a continuous uniform distribution without pre-specified parameter values. -*/ -interface TernaryFunction extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @param len - array length - * @param a - minimum support - * @param b - maximum support - * @param options - function options - * @returns output array - */ - ( len: number, a: number, b: number, options?: Options ): RandomArray; -} - -/** -* Interface for generating pseudorandom numbers drawn from a uniform distribution. -*/ -interface Random extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @param len - array length - * @param a - minimum support - * @param b - maximum support - * @param options - function options - * @returns output array - * - * @example - * var out = uniform( 10, 2.0, 5.0 ); - * // returns - */ - ( len: number, a: number, b: number, options?: Options ): RandomArray; - - /** - * Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution. - * - * ## Notes - * - * - When provided `a` and `b`, the returned function returns random variates drawn from the specified distribution. - * - * @param a - minimum support - * @param b - maximum support - * @param options - function options - * @throws `a` must be less than `b` - * @throws must provide a valid state - * @returns function for creating arrays - * - * @example - * var random = uniform.factory( 2.0, 5.0 ); - * - * var out = random( 10 ); - * // returns - * - * @example - * var random = uniform.factory( 2.0, 5.0, { - * 'seed': 297 - * }); - * var out = random( 10 ); - * // returns - */ - factory( a: number, b: number, options?: FactoryOptions ): UnaryFunction; - - /** - * Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution. - * - * ## Notes - * - * - When not provided `a` and `b`, the returned function requires that both `a` and `b` be provided at each invocation. - * - * @param options - function options - * @throws must provide a valid state - * @returns function for creating arrays - * - * @example - * var random = uniform.factory(); - * - * var out = random( 10, 2.0, 5.0 ); - * // returns - * - * @example - * var random = uniform.factory({ - * 'seed': 297 - * }); - * var out = random( 10, 2.0, 5.0 ); - * // returns - */ - factory( options?: FactoryOptions ): TernaryFunction; -} - -/** -* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. -* -* @param len - array length -* @param a - minimum support -* @param b - maximum support -* @param options - function options -* @returns output array -* -* @example -* var out = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var random = uniform.factory( 2.0, 5.0 ); -* -* var out = random( 10 ); -* // returns -*/ -declare var uniform: Random; - - -// EXPORTS // - -export = uniform; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 411d38d..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.1.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-accessor@v0.1.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-write-accessor@v0.1.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-constant-function@v0.1.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-noop@v0.1.1-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/random-base-uniform@v0.1.0-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-typed-real-float-ctors@v0.1.0-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@v0.1.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-nullary@v0.1.0-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@v0.1.0-esm/index.mjs";import f from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.1.1-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/array-typed-real-float-dtypes@v0.1.1-esm/index.mjs";import h from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.1.0-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.1.1-esm/index.mjs";var c="float64",u=a();function g(e,t){return h(t)?j(t,"dtype")&&(e.dtype=t.dtype,u.indexOf(e.dtype)<0)?new TypeError(f("1eR2X,3g,4S,GD,Gg,Jm","dtype",u.join('", "'),e.dtype)):null:new TypeError(f("1eR2V,FD",t))}function v(){var a,h,j,u,v,y;if(j={dtype:c},0===(h=arguments.length))v=d,u=x;else if(1===h){if(a=arguments[0],v=d.factory(a),y=g(j,a))throw y;u=x}else if(2===h)v=d.factory(arguments[0],arguments[1]),u=b;else if(3===h){if(a=arguments[2],v=d.factory(arguments[0],arguments[1],a),y=g(j,a))throw y;u=b}return a&&a.prng?(e(u,"seed",null),e(u,"seedLength",null),n(u,"state",r(null),i),e(u,"stateLength",null),e(u,"byteLength",null)):(s(u,"seed",w),s(u,"seedLength",G),n(u,"state",N,P),s(u,"stateLength",R),s(u,"byteLength",L)),e(u,"PRNG",v.PRNG),u;function b(e,s){var n,r,i,d;if(!t(e))throw new TypeError(f("1eR2d,MG",e));if(d={},arguments.length>1&&(r=g(d,s)))throw r;return"generic"===(i=d.dtype||j.dtype)?l(e,v):(n=new(o(i))(e),m([n],[e],[1],v),n)}function x(e,s,n,r){var i,d,m,a;if(!t(e))throw new TypeError(f("1eR2d,MG",e));if(a={},arguments.length>3&&(d=g(a,r)))throw d;return"generic"===(m=a.dtype||j.dtype)?l(e,h):(i=new(o(m))(e),p([[s],[n],i],[e],[0,0,1],v),i);function h(){return v(s,n)}}function w(){return u.PRNG.seed}function G(){return u.PRNG.seedLength}function R(){return u.PRNG.stateLength}function L(){return u.PRNG.byteLength}function N(){return u.PRNG.state}function P(e){u.PRNG.state=e}}u.push("generic");var y=v();e(y,"factory",v);export{y as default,v as factory}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index f442194..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/factory.js","../lib/main.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 dtypes from '@stdlib/array-typed-real-float-dtypes';\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes();\nDTYPES.push( 'generic' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '1eR2V,FD', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( DTYPES.indexOf( opts.dtype ) < 0 ) {\n\t\t\treturn new TypeError( format( '1eR2X,3g,4S,GD,Gg,Jm', 'dtype', DTYPES.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport setReadOnlyAccessor from '@stdlib/utils-define-nonenumerable-read-only-accessor';\nimport setReadWriteAccessor from '@stdlib/utils-define-nonenumerable-read-write-accessor';\nimport constantFunction from '@stdlib/utils-constant-function';\nimport noop from '@stdlib/utils-noop';\nimport base from '@stdlib/random-base-uniform';\nimport ctors from '@stdlib/array-typed-real-float-ctors';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport nullary from '@stdlib/strided-base-nullary';\nimport binary from '@stdlib/strided-base-binary';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution.\n*\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\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 {RangeError} `a` must be less than `b`\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 uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10 );\n* // returns \n*\n* @example\n* var uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nfunction factory() {\n\tvar options;\n\tvar nargs;\n\tvar opts;\n\tvar rand;\n\tvar prng;\n\tvar err;\n\n\topts = {\n\t\t'dtype': defaults.dtype\n\t};\n\n\tnargs = arguments.length;\n\tif ( nargs === 0 ) {\n\t\tprng = base;\n\t\trand = uniform2;\n\t} else if ( nargs === 1 ) {\n\t\toptions = arguments[ 0 ];\n\t\tprng = base.factory( options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform2;\n\t} else if ( nargs === 2 ) {\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ] );\n\t\trand = uniform1;\n\t} else if ( nargs === 3 ) {\n\t\toptions = arguments[ 2 ];\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ], options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform1;\n\t}\n\tif ( options && options.prng ) {\n\t\tsetReadOnly( rand, 'seed', null );\n\t\tsetReadOnly( rand, 'seedLength', null );\n\t\tsetReadWriteAccessor( rand, 'state', constantFunction( null ), noop );\n\t\tsetReadOnly( rand, 'stateLength', null );\n\t\tsetReadOnly( rand, 'byteLength', null );\n\t} else {\n\t\tsetReadOnlyAccessor( rand, 'seed', getSeed );\n\t\tsetReadOnlyAccessor( rand, 'seedLength', getSeedLength );\n\t\tsetReadWriteAccessor( rand, 'state', getState, setState );\n\t\tsetReadOnlyAccessor( rand, 'stateLength', getStateLength );\n\t\tsetReadOnlyAccessor( rand, 'byteLength', getStateSize );\n\t}\n\tsetReadOnly( rand, 'PRNG', prng.PRNG );\n\treturn rand;\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform1( len, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( '1eR2d,MG', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 1 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, prng );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tnullary( [ out ], [ len ], [ 1 ], prng );\n\t\treturn out;\n\t}\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {number} a - minimum support\n\t* @param {number} b - maximum support\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform2( len, a, b, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( '1eR2d,MG', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 3 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\t// NOTE: we could alternatively use the PRNG factory function to create a PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. Decision made here to avoid this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom number. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in a return value of `NaN`.\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, wrapper );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tbinary( [ [ a ], [ b ], out ], [ len ], [ 0, 0, 1 ], prng );\n\t\treturn out;\n\n\t\t/**\n\t\t* Applies parameters to a pseudorandom number generator function.\n\t\t*\n\t\t* @private\n\t\t* @returns {number} pseudorandom number\n\t\t*/\n\t\tfunction wrapper() {\n\t\t\treturn prng( a, b );\n\t\t}\n\t}\n\n\t/**\n\t* Returns the PRNG seed.\n\t*\n\t* @private\n\t* @returns {PRNGSeedMT19937} seed\n\t*/\n\tfunction getSeed() {\n\t\treturn rand.PRNG.seed;\n\t}\n\n\t/**\n\t* Returns the PRNG seed length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} seed length\n\t*/\n\tfunction getSeedLength() {\n\t\treturn rand.PRNG.seedLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state length\n\t*/\n\tfunction getStateLength() {\n\t\treturn rand.PRNG.stateLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state size (in bytes).\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state size (in bytes)\n\t*/\n\tfunction getStateSize() {\n\t\treturn rand.PRNG.byteLength;\n\t}\n\n\t/**\n\t* Returns the current pseudorandom number generator state.\n\t*\n\t* @private\n\t* @returns {PRNGStateMT19937} current state\n\t*/\n\tfunction getState() {\n\t\treturn rand.PRNG.state;\n\t}\n\n\t/**\n\t* Sets the pseudorandom number generator state.\n\t*\n\t* @private\n\t* @param {PRNGStateMT19937} s - generator state\n\t* @throws {Error} must provide a valid state\n\t*/\n\tfunction setState( s ) {\n\t\trand.PRNG.state = s;\n\t}\n}\n\n\n// EXPORTS //\n\nexport default factory;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @name uniform\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\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 = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar uniform = factory();\n\n\n// EXPORTS //\n\nexport default uniform;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @module @stdlib/random-array-uniform\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.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\" }\n"],"names":["DTYPES","dtypes","validate","opts","options","isObject","hasOwnProp","dtype","indexOf","TypeError","format","join","factory","nargs","rand","prng","err","defaults","arguments","length","base","uniform2","uniform1","setReadOnly","setReadWriteAccessor","constantFunction","noop","setReadOnlyAccessor","getSeed","getSeedLength","getState","setState","getStateLength","getStateSize","PRNG","len","out","dt","o","isNonNegativeInteger","filledBy","ctors","nullary","a","b","wrapper","binary","seed","seedLength","stateLength","byteLength","state","s","push","uniform","main"],"mappings":";;ohDA8BIA,EAASC,IAyBb,SAASC,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,WACzBD,EAAKI,MAAQH,EAAQG,MAChBP,EAAOQ,QAASL,EAAKI,OAAU,GAC5B,IAAIE,UAAWC,EAAQ,uBAAwB,QAASV,EAAOW,KAAM,QAAUR,EAAKI,QAGtF,KARC,IAAIE,UAAWC,EAAQ,WAAYN,GAS5C,CCSA,SAASQ,IACR,IAAIR,EACAS,EACAV,EACAW,EACAC,EACAC,EAOJ,GALAb,EAAO,CACNI,MAASU,GAIK,KADfJ,EAAQK,UAAUC,QAEjBJ,EAAOK,EACPN,EAAOO,OACD,GAAe,IAAVR,EAAc,CAIzB,GAHAT,EAAUc,UAAW,GACrBH,EAAOK,EAAKR,QAASR,GACrBY,EAAMd,EAAUC,EAAMC,GAErB,MAAMY,EAEPF,EAAOO,CACT,MAAQ,GAAe,IAAVR,EACXE,EAAOK,EAAKR,QAASM,UAAW,GAAKA,UAAW,IAChDJ,EAAOQ,OACD,GAAe,IAAVT,EAAc,CAIzB,GAHAT,EAAUc,UAAW,GACrBH,EAAOK,EAAKR,QAASM,UAAW,GAAKA,UAAW,GAAKd,GACrDY,EAAMd,EAAUC,EAAMC,GAErB,MAAMY,EAEPF,EAAOQ,CACP,CAeD,OAdKlB,GAAWA,EAAQW,MACvBQ,EAAaT,EAAM,OAAQ,MAC3BS,EAAaT,EAAM,aAAc,MACjCU,EAAsBV,EAAM,QAASW,EAAkB,MAAQC,GAC/DH,EAAaT,EAAM,cAAe,MAClCS,EAAaT,EAAM,aAAc,QAEjCa,EAAqBb,EAAM,OAAQc,GACnCD,EAAqBb,EAAM,aAAce,GACzCL,EAAsBV,EAAM,QAASgB,EAAUC,GAC/CJ,EAAqBb,EAAM,cAAekB,GAC1CL,EAAqBb,EAAM,aAAcmB,IAE1CV,EAAaT,EAAM,OAAQC,EAAKmB,MACzBpB,EAcP,SAASQ,EAAUa,EAAK/B,GACvB,IACIgC,EACApB,EACAqB,EACAC,EACJ,IAAMC,EAAsBJ,GAC3B,MAAM,IAAI1B,UAAWC,EAAQ,WAAYyB,IAG1C,GADAG,EAAI,CAAA,EACCpB,UAAUC,OAAS,IACvBH,EAAMd,EAAUoC,EAAGlC,IAElB,MAAMY,EAIR,MAAY,aADZqB,EAAKC,EAAE/B,OAASJ,EAAKI,OAEbiC,EAAUL,EAAKpB,IAGvBqB,EAAM,IADCK,EAAOJ,GACR,CAAUF,GAChBO,EAAS,CAAEN,GAAO,CAAED,GAAO,CAAE,GAAKpB,GAC3BqB,EACP,CAgBD,SAASf,EAAUc,EAAKQ,EAAGC,EAAGxC,GAC7B,IACIgC,EACApB,EACAqB,EACAC,EACJ,IAAMC,EAAsBJ,GAC3B,MAAM,IAAI1B,UAAWC,EAAQ,WAAYyB,IAG1C,GADAG,EAAI,CAAA,EACCpB,UAAUC,OAAS,IACvBH,EAAMd,EAAUoC,EAAGlC,IAElB,MAAMY,EAKR,MAAY,aADZqB,EAAKC,EAAE/B,OAASJ,EAAKI,OAEbiC,EAAUL,EAAKU,IAGvBT,EAAM,IADCK,EAAOJ,GACR,CAAUF,GAChBW,EAAQ,CAAE,CAAEH,GAAK,CAAEC,GAAKR,GAAO,CAAED,GAAO,CAAE,EAAG,EAAG,GAAKpB,GAC9CqB,GAQP,SAASS,IACR,OAAO9B,EAAM4B,EAAGC,EAChB,CACD,CAQD,SAAShB,IACR,OAAOd,EAAKoB,KAAKa,IACjB,CAQD,SAASlB,IACR,OAAOf,EAAKoB,KAAKc,UACjB,CAQD,SAAShB,IACR,OAAOlB,EAAKoB,KAAKe,WACjB,CAQD,SAAShB,IACR,OAAOnB,EAAKoB,KAAKgB,UACjB,CAQD,SAASpB,IACR,OAAOhB,EAAKoB,KAAKiB,KACjB,CASD,SAASpB,EAAUqB,GAClBtC,EAAKoB,KAAKiB,MAAQC,CAClB,CACF,CDrPApD,EAAOqD,KAAM,WEqBV,IAACC,EAAU1C,ICiBdW,EAAAgC,EAAA,UAAA3C"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index a3dae90..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 6090a8829fc445bc4acf63932798884ae0354c18 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 2 Dec 2023 14:20:28 +0000 Subject: [PATCH 42/82] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 --- .github/workflows/publish.yml | 255 - .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 128 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 227 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 61 +- benchmark/benchmark.float32.factory.js | 96 - benchmark/benchmark.float32.js | 98 - benchmark/benchmark.float64.factory.js | 96 - benchmark/benchmark.float64.js | 98 - benchmark/benchmark.generic.factory.js | 96 - benchmark/benchmark.generic.js | 98 - branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 9 - dist/index.js.map | 7 - docs/repl.txt | 169 - docs/types/test.ts | 355 -- examples/index.js | 48 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/defaults.json | 3 - lib/factory.js | 282 - lib/index.js | 77 - lib/main.js | 58 - lib/validate.js | 72 - package.json | 76 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.factory.js | 1328 ----- test/test.js | 69 - test/test.main.js | 244 - test/test.validate.js | 118 - 53 files changed, 6215 insertions(+), 6779 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 benchmark/benchmark.float32.factory.js delete mode 100644 benchmark/benchmark.float32.js delete mode 100644 benchmark/benchmark.float64.factory.js delete mode 100644 benchmark/benchmark.float64.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/defaults.json delete mode 100644 lib/factory.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.factory.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js delete mode 100644 test/test.validate.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 19bee82..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2023-12-01T06:27:59.551Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index c4ab52b..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/uniform) 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 ab56cca..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 corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # 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: 16 - 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 5097056..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/uniform) 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 c1c45e7..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 corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # 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: 16 - 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 bd8d245..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: '33 9 * * 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 corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - 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: 16 - 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 corresponding to v3.0.3: - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 - 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 265afda..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 corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - 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: 16 - 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 corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - 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: 16 - 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 corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # 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: 16 - 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 corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # 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: 16 - 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 + + ```
@@ -375,7 +374,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]. @@ -435,13 +434,13 @@ Copyright © 2016-2023. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/random-array-uniform/main/LICENSE -[@stdlib/random/base/uniform]: https://github.com/stdlib-js/random-base-uniform +[@stdlib/random/base/uniform]: https://github.com/stdlib-js/random-base-uniform/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/benchmark/benchmark.float32.factory.js b/benchmark/benchmark.float32.factory.js deleted file mode 100644 index 67e61f4..0000000 --- a/benchmark/benchmark.float32.factory.js +++ /dev/null @@ -1,96 +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 bench = require( '@stdlib/bench' ); -var isnanf = require( '@stdlib/math-base-assert-is-nanf' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var fcn = uniform.factory( 2.0, 5.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 4642816..0000000 --- a/benchmark/benchmark.float32.js +++ /dev/null @@ -1,98 +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 bench = require( '@stdlib/bench' ); -var isnanf = require( '@stdlib/math-base-assert-is-nanf' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = 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 = uniform( len, 2.0, 5.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.factory.js b/benchmark/benchmark.float64.factory.js deleted file mode 100644 index 8646a54..0000000 --- a/benchmark/benchmark.float64.factory.js +++ /dev/null @@ -1,96 +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 bench = require( '@stdlib/bench' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var fcn = uniform.factory( 2.0, 5.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 5ee0d97..0000000 --- a/benchmark/benchmark.float64.js +++ /dev/null @@ -1,98 +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 bench = require( '@stdlib/bench' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = 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 = uniform( len, 2.0, 5.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.factory.js b/benchmark/benchmark.generic.factory.js deleted file mode 100644 index 7020d62..0000000 --- a/benchmark/benchmark.generic.factory.js +++ /dev/null @@ -1,96 +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 bench = require( '@stdlib/bench' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var fcn = uniform.factory( 2.0, 5.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 06a2a83..0000000 --- a/benchmark/benchmark.generic.js +++ /dev/null @@ -1,98 +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 bench = require( '@stdlib/bench' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = 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 = uniform( len, 2.0, 5.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 30542fb..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/uniform" -%% click B href "https://github.com/stdlib-js/random-array-uniform/tree/main" -%% click C href "https://github.com/stdlib-js/random-array-uniform/tree/production" -%% click D href "https://github.com/stdlib-js/random-array-uniform/tree/esm" -%% click E href "https://github.com/stdlib-js/random-array-uniform/tree/deno" -%% click F href "https://github.com/stdlib-js/random-array-uniform/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/uniform -[production-url]: https://github.com/stdlib-js/random-array-uniform/tree/production -[deno-url]: https://github.com/stdlib-js/random-array-uniform/tree/deno -[umd-url]: https://github.com/stdlib-js/random-array-uniform/tree/umd -[esm-url]: https://github.com/stdlib-js/random-array-uniform/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 f2a679f..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import uniform from '../docs/types/index'; -export = uniform; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 0ef1443..0000000 --- a/dist/index.js +++ /dev/null @@ -1,9 +0,0 @@ -"use strict";var y=function(t,r){return function(){return r||t((r={exports:{}}).exports,r),r.exports}};var b=y(function(ue,H){H.exports={dtype:"float64"}});var O=y(function(se,G){ -var J=require('@stdlib/array-typed-real-float-dtypes/dist'),K=require('@stdlib/assert-is-plain-object/dist'),M=require('@stdlib/assert-has-own-property/dist'),N=require('@stdlib/error-tools-fmtprodmsg/dist'),w=J();w.push("generic");function Q(t,r){return K(r)?M(r,"dtype")&&(t.dtype=r.dtype,w.indexOf(t.dtype)<0)?new TypeError(N('1eR4S',"dtype",w.join('", "'),t.dtype)):null:new TypeError(N('1eR2V',r));}G.exports=Q -});var R=y(function(oe,F){ -var S=require('@stdlib/assert-is-nonnegative-integer/dist').isPrimitive,d=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),l=require('@stdlib/utils-define-nonenumerable-read-only-accessor/dist'),x=require('@stdlib/utils-define-nonenumerable-read-write-accessor/dist'),U=require('@stdlib/utils-constant-function/dist'),X=require('@stdlib/utils-noop/dist'),p=require('@stdlib/random-base-uniform/dist'),E=require('@stdlib/array-typed-real-float-ctors/dist'),T=require('@stdlib/array-base-filled-by/dist'),Z=require('@stdlib/strided-base-nullary/dist'),_=require('@stdlib/strided-base-binary/dist'),j=require('@stdlib/error-tools-fmtprodmsg/dist'),$=b(),m=O();function ee(){var t,r,v,e,a,s;if(v={dtype:$.dtype},r=arguments.length,r===0)a=p,e=P;else if(r===1){if(t=arguments[0],a=p.factory(t),s=m(v,t),s)throw s;e=P}else if(r===2)a=p.factory(arguments[0],arguments[1]),e=L;else if(r===3){if(t=arguments[2],a=p.factory(arguments[0],arguments[1],t),s=m(v,t),s)throw s;e=L}return t&&t.prng?(d(e,"seed",null),d(e,"seedLength",null),x(e,"state",U(null),X),d(e,"stateLength",null),d(e,"byteLength",null)):(l(e,"seed",B),l(e,"seedLength",D),x(e,"state",Y,k),l(e,"stateLength",I),l(e,"byteLength",W)),d(e,"PRNG",a.PRNG),e;function L(n,c){var f,g,o,i,u;if(!S(n))throw new TypeError(j('1eR2d',n));if(u={},arguments.length>1&&(o=m(u,c),o))throw o;return i=u.dtype||v.dtype,i==="generic"?T(n,a):(f=E(i),g=new f(n),Z([g],[n],[1],a),g)}function P(n,c,f,g){var o,i,u,h,q;if(!S(n))throw new TypeError(j('1eR2d',n));if(q={},arguments.length>3&&(u=m(q,g),u))throw u;if(h=q.dtype||v.dtype,h==="generic")return T(n,C);return o=E(h),i=new o(n),_([[c],[f],i],[n],[0,0,1],a),i;function C(){return a(c,f)}}function B(){return e.PRNG.seed}function D(){return e.PRNG.seedLength}function I(){return e.PRNG.stateLength}function W(){return e.PRNG.byteLength}function Y(){return e.PRNG.state}function k(n){e.PRNG.state=n}}F.exports=ee -});var A=y(function(ve,V){ -var re=R(),te=re();V.exports=te -});var ne=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),z=A(),ae=R();ne(z,"factory",ae);module.exports=z; -/** @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 fcb8851..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/defaults.json", "../lib/validate.js", "../lib/factory.js", "../lib/main.js", "../lib/index.js"], - "sourcesContent": ["{\n\t\"dtype\": \"float64\"\n}\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 dtypes = require( '@stdlib/array-typed-real-float-dtypes' );\nvar isObject = require( '@stdlib/assert-is-plain-object' );\nvar hasOwnProp = require( '@stdlib/assert-has-own-property' );\nvar format = require( '@stdlib/string-format' );\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes();\nDTYPES.push( 'generic' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( DTYPES.indexOf( opts.dtype ) < 0 ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be one of the following: \"%s\". Option: `%s`.', 'dtype', DTYPES.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nmodule.exports = validate;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive;\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar setReadOnlyAccessor = require( '@stdlib/utils-define-nonenumerable-read-only-accessor' );\nvar setReadWriteAccessor = require( '@stdlib/utils-define-nonenumerable-read-write-accessor' );\nvar constantFunction = require( '@stdlib/utils-constant-function' );\nvar noop = require( '@stdlib/utils-noop' );\nvar base = require( '@stdlib/random-base-uniform' );\nvar ctors = require( '@stdlib/array-typed-real-float-ctors' );\nvar filledBy = require( '@stdlib/array-base-filled-by' );\nvar nullary = require( '@stdlib/strided-base-nullary' );\nvar binary = require( '@stdlib/strided-base-binary' );\nvar format = require( '@stdlib/string-format' );\nvar defaults = require( './defaults.json' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution.\n*\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\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 {RangeError} `a` must be less than `b`\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 uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10 );\n* // returns \n*\n* @example\n* var uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nfunction factory() {\n\tvar options;\n\tvar nargs;\n\tvar opts;\n\tvar rand;\n\tvar prng;\n\tvar err;\n\n\topts = {\n\t\t'dtype': defaults.dtype\n\t};\n\n\tnargs = arguments.length;\n\tif ( nargs === 0 ) {\n\t\tprng = base;\n\t\trand = uniform2;\n\t} else if ( nargs === 1 ) {\n\t\toptions = arguments[ 0 ];\n\t\tprng = base.factory( options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform2;\n\t} else if ( nargs === 2 ) {\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ] );\n\t\trand = uniform1;\n\t} else if ( nargs === 3 ) {\n\t\toptions = arguments[ 2 ];\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ], options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform1;\n\t}\n\tif ( options && options.prng ) {\n\t\tsetReadOnly( rand, 'seed', null );\n\t\tsetReadOnly( rand, 'seedLength', null );\n\t\tsetReadWriteAccessor( rand, 'state', constantFunction( null ), noop );\n\t\tsetReadOnly( rand, 'stateLength', null );\n\t\tsetReadOnly( rand, 'byteLength', null );\n\t} else {\n\t\tsetReadOnlyAccessor( rand, 'seed', getSeed );\n\t\tsetReadOnlyAccessor( rand, 'seedLength', getSeedLength );\n\t\tsetReadWriteAccessor( rand, 'state', getState, setState );\n\t\tsetReadOnlyAccessor( rand, 'stateLength', getStateLength );\n\t\tsetReadOnlyAccessor( rand, 'byteLength', getStateSize );\n\t}\n\tsetReadOnly( rand, 'PRNG', prng.PRNG );\n\treturn rand;\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform1( len, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 1 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, prng );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tnullary( [ out ], [ len ], [ 1 ], prng );\n\t\treturn out;\n\t}\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {number} a - minimum support\n\t* @param {number} b - maximum support\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform2( len, a, b, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 3 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\t// NOTE: we could alternatively use the PRNG factory function to create a PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. Decision made here to avoid this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom number. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in a return value of `NaN`.\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, wrapper );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tbinary( [ [ a ], [ b ], out ], [ len ], [ 0, 0, 1 ], prng );\n\t\treturn out;\n\n\t\t/**\n\t\t* Applies parameters to a pseudorandom number generator function.\n\t\t*\n\t\t* @private\n\t\t* @returns {number} pseudorandom number\n\t\t*/\n\t\tfunction wrapper() {\n\t\t\treturn prng( a, b );\n\t\t}\n\t}\n\n\t/**\n\t* Returns the PRNG seed.\n\t*\n\t* @private\n\t* @returns {PRNGSeedMT19937} seed\n\t*/\n\tfunction getSeed() {\n\t\treturn rand.PRNG.seed;\n\t}\n\n\t/**\n\t* Returns the PRNG seed length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} seed length\n\t*/\n\tfunction getSeedLength() {\n\t\treturn rand.PRNG.seedLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state length\n\t*/\n\tfunction getStateLength() {\n\t\treturn rand.PRNG.stateLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state size (in bytes).\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state size (in bytes)\n\t*/\n\tfunction getStateSize() {\n\t\treturn rand.PRNG.byteLength;\n\t}\n\n\t/**\n\t* Returns the current pseudorandom number generator state.\n\t*\n\t* @private\n\t* @returns {PRNGStateMT19937} current state\n\t*/\n\tfunction getState() {\n\t\treturn rand.PRNG.state;\n\t}\n\n\t/**\n\t* Sets the pseudorandom number generator state.\n\t*\n\t* @private\n\t* @param {PRNGStateMT19937} s - generator state\n\t* @throws {Error} must provide a valid state\n\t*/\n\tfunction setState( s ) {\n\t\trand.PRNG.state = s;\n\t}\n}\n\n\n// EXPORTS //\n\nmodule.exports = factory;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @name uniform\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\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 = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar uniform = factory();\n\n\n// EXPORTS //\n\nmodule.exports = uniform;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @module @stdlib/random-array-uniform\n*\n* @example\n* var uniform = require( '@stdlib/random-array-uniform' );\n*\n* var arr = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var uniform = require( '@stdlib/random-array-uniform' );\n*\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* var uniform = require( '@stdlib/random-array-uniform' );\n*\n* var rand = uniform.factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* var uniform = require( '@stdlib/random-array-uniform' );\n*\n* var rand = uniform.factory( 2.0, 5.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\" }\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,GAAAC,EAAA,CAAAA,EAAA,SACC,MAAS,SACV,ICFA,IAAAC,EAAAC,EAAA,SAAAC,GAAAC,EAAA,cAsBA,IAAIC,EAAS,QAAS,uCAAwC,EAC1DC,EAAW,QAAS,gCAAiC,EACrDC,EAAa,QAAS,iCAAkC,EACxDC,EAAS,QAAS,uBAAwB,EAK1CC,EAASJ,EAAO,EACpBI,EAAO,KAAM,SAAU,EAwBvB,SAASC,EAAUC,EAAMC,EAAU,CAClC,OAAMN,EAAUM,CAAQ,EAGnBL,EAAYK,EAAS,OAAQ,IACjCD,EAAK,MAAQC,EAAQ,MAChBH,EAAO,QAASE,EAAK,KAAM,EAAI,GAC5B,IAAI,UAAWH,EAAQ,gFAAiF,QAASC,EAAO,KAAM,MAAO,EAAGE,EAAK,KAAM,CAAE,EAGvJ,KARC,IAAI,UAAWH,EAAQ,qEAAsEI,CAAQ,CAAE,CAShH,CAKAR,EAAO,QAAUM,ICvEjB,IAAAG,EAAAC,EAAA,SAAAC,GAAAC,EAAA,cAsBA,IAAIC,EAAuB,QAAS,uCAAwC,EAAE,YAC1EC,EAAc,QAAS,uDAAwD,EAC/EC,EAAsB,QAAS,uDAAwD,EACvFC,EAAuB,QAAS,wDAAyD,EACzFC,EAAmB,QAAS,iCAAkC,EAC9DC,EAAO,QAAS,oBAAqB,EACrCC,EAAO,QAAS,6BAA8B,EAC9CC,EAAQ,QAAS,sCAAuC,EACxDC,EAAW,QAAS,8BAA+B,EACnDC,EAAU,QAAS,8BAA+B,EAClDC,EAAS,QAAS,6BAA8B,EAChDC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IACXC,EAAW,IAwCf,SAASC,IAAU,CAClB,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EAOJ,GALAH,EAAO,CACN,MAASL,EAAS,KACnB,EAEAI,EAAQ,UAAU,OACbA,IAAU,EACdG,EAAOb,EACPY,EAAOG,UACIL,IAAU,EAAI,CAIzB,GAHAD,EAAU,UAAW,CAAE,EACvBI,EAAOb,EAAK,QAASS,CAAQ,EAC7BK,EAAMP,EAAUI,EAAMF,CAAQ,EACzBK,EACJ,MAAMA,EAEPF,EAAOG,CACR,SAAYL,IAAU,EACrBG,EAAOb,EAAK,QAAS,UAAW,CAAE,EAAG,UAAW,CAAE,CAAE,EACpDY,EAAOI,UACIN,IAAU,EAAI,CAIzB,GAHAD,EAAU,UAAW,CAAE,EACvBI,EAAOb,EAAK,QAAS,UAAW,CAAE,EAAG,UAAW,CAAE,EAAGS,CAAQ,EAC7DK,EAAMP,EAAUI,EAAMF,CAAQ,EACzBK,EACJ,MAAMA,EAEPF,EAAOI,CACR,CACA,OAAKP,GAAWA,EAAQ,MACvBd,EAAaiB,EAAM,OAAQ,IAAK,EAChCjB,EAAaiB,EAAM,aAAc,IAAK,EACtCf,EAAsBe,EAAM,QAASd,EAAkB,IAAK,EAAGC,CAAK,EACpEJ,EAAaiB,EAAM,cAAe,IAAK,EACvCjB,EAAaiB,EAAM,aAAc,IAAK,IAEtChB,EAAqBgB,EAAM,OAAQK,CAAQ,EAC3CrB,EAAqBgB,EAAM,aAAcM,CAAc,EACvDrB,EAAsBe,EAAM,QAASO,EAAUC,CAAS,EACxDxB,EAAqBgB,EAAM,cAAeS,CAAe,EACzDzB,EAAqBgB,EAAM,aAAcU,CAAa,GAEvD3B,EAAaiB,EAAM,OAAQC,EAAK,IAAK,EAC9BD,EAcP,SAASI,EAAUO,EAAKd,EAAU,CACjC,IAAIe,EACAC,EACAX,EACAY,EACAC,EACJ,GAAK,CAACjC,EAAsB6B,CAAI,EAC/B,MAAM,IAAI,UAAWlB,EAAQ,+EAAgFkB,CAAI,CAAE,EAGpH,GADAI,EAAI,CAAC,EACA,UAAU,OAAS,IACvBb,EAAMP,EAAUoB,EAAGlB,CAAQ,EACtBK,GACJ,MAAMA,EAIR,OADAY,EAAKC,EAAE,OAAShB,EAAK,MAChBe,IAAO,UACJxB,EAAUqB,EAAKV,CAAK,GAE5BW,EAAOvB,EAAOyB,CAAG,EACjBD,EAAM,IAAID,EAAMD,CAAI,EACpBpB,EAAS,CAAEsB,CAAI,EAAG,CAAEF,CAAI,EAAG,CAAE,CAAE,EAAGV,CAAK,EAChCY,EACR,CAgBA,SAASV,EAAUQ,EAAKK,EAAGC,EAAGpB,EAAU,CACvC,IAAIe,EACAC,EACAX,EACAY,EACAC,EACJ,GAAK,CAACjC,EAAsB6B,CAAI,EAC/B,MAAM,IAAI,UAAWlB,EAAQ,+EAAgFkB,CAAI,CAAE,EAGpH,GADAI,EAAI,CAAC,EACA,UAAU,OAAS,IACvBb,EAAMP,EAAUoB,EAAGlB,CAAQ,EACtBK,GACJ,MAAMA,EAKR,GADAY,EAAKC,EAAE,OAAShB,EAAK,MAChBe,IAAO,UACX,OAAOxB,EAAUqB,EAAKO,CAAQ,EAE/B,OAAAN,EAAOvB,EAAOyB,CAAG,EACjBD,EAAM,IAAID,EAAMD,CAAI,EACpBnB,EAAQ,CAAE,CAAEwB,CAAE,EAAG,CAAEC,CAAE,EAAGJ,CAAI,EAAG,CAAEF,CAAI,EAAG,CAAE,EAAG,EAAG,CAAE,EAAGV,CAAK,EACnDY,EAQP,SAASK,GAAU,CAClB,OAAOjB,EAAMe,EAAGC,CAAE,CACnB,CACD,CAQA,SAASZ,GAAU,CAClB,OAAOL,EAAK,KAAK,IAClB,CAQA,SAASM,GAAgB,CACxB,OAAON,EAAK,KAAK,UAClB,CAQA,SAASS,GAAiB,CACzB,OAAOT,EAAK,KAAK,WAClB,CAQA,SAASU,GAAe,CACvB,OAAOV,EAAK,KAAK,UAClB,CAQA,SAASO,GAAW,CACnB,OAAOP,EAAK,KAAK,KAClB,CASA,SAASQ,EAAUW,EAAI,CACtBnB,EAAK,KAAK,MAAQmB,CACnB,CACD,CAKAtC,EAAO,QAAUe,KCzRjB,IAAAwB,EAAAC,EAAA,SAAAC,GAAAC,EAAA,cAsBA,IAAIC,GAAU,IA8BVC,GAAUD,GAAQ,EAKtBD,EAAO,QAAUE,KCKjB,IAAIC,GAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,GAAU,IAKdF,GAAaC,EAAM,UAAWC,EAAQ,EAKtC,OAAO,QAAUD", - "names": ["require_defaults", "__commonJSMin", "exports", "module", "require_validate", "__commonJSMin", "exports", "module", "dtypes", "isObject", "hasOwnProp", "format", "DTYPES", "validate", "opts", "options", "require_factory", "__commonJSMin", "exports", "module", "isNonNegativeInteger", "setReadOnly", "setReadOnlyAccessor", "setReadWriteAccessor", "constantFunction", "noop", "base", "ctors", "filledBy", "nullary", "binary", "format", "defaults", "validate", "factory", "options", "nargs", "opts", "rand", "prng", "err", "uniform2", "uniform1", "getSeed", "getSeedLength", "getState", "setState", "getStateLength", "getStateSize", "len", "ctor", "out", "dt", "o", "a", "b", "wrapper", "s", "require_main", "__commonJSMin", "exports", "module", "factory", "uniform", "setReadOnly", "main", "factory"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 256216a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,169 +0,0 @@ - -{{alias}}( len, a, b[, options] ) - Returns an array containing pseudorandom numbers drawn from a continuous - uniform distribution. - - Parameters - ---------- - len: integer - Output array length. - - a: number - Minimum support. - - b: number - Maximum support. - - 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 ) - - - -{{alias}}.factory( [a, b, ][options] ) - Returns a function for creating arrays containing pseudorandom numbers drawn - from a continuous uniform distribution. - - If provided `a` and `b`, the returned function returns random variates drawn - from the specified distribution. - - If not provided `a` and `b`, the returned function requires that both `a` - and `b` 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. - - 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 ) - - - // Provide distribution parameters: - > fcn = {{alias}}.factory( 2.0, 5.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 ) - - - // Get a copy of the current state: - > var state = {{alias}}.state - - - > out = {{alias}}( 3, 2.0, 5.0 ) - - > out = {{alias}}( 3, 2.0, 5.0 ) - - - // Set the state: - > {{alias}}.state = state; - - // Regenerate a previous array: - > out = {{alias}}( 3, 2.0, 5.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 a087b98..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,355 +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. -*/ - -import random = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - random( 10, 2, 3 ); // $ExpectType RandomArray - random( 10, 1, 2 ); // $ExpectType RandomArray - random( 10, 1, 2, {} ); // $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 ); // $ExpectError - random( true, 2.0, 5.0 ); // $ExpectError - random( false, 2.0, 5.0 ); // $ExpectError - random( null, 2.0, 5.0 ); // $ExpectError - random( [], 2.0, 5.0 ); // $ExpectError - random( {}, 2.0, 5.0 ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - random( '5', 2.0, 5.0, {} ); // $ExpectError - random( true, 2.0, 5.0, {} ); // $ExpectError - random( false, 2.0, 5.0, {} ); // $ExpectError - random( null, 2.0, 5.0, {} ); // $ExpectError - random( [], 2.0, 5.0, {} ); // $ExpectError - random( {}, 2.0, 5.0, {} ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.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 ); // $ExpectError - random( 10, true, 5.0 ); // $ExpectError - random( 10, false, 5.0 ); // $ExpectError - random( 10, null, 5.0 ); // $ExpectError - random( 10, [], 5.0 ); // $ExpectError - random( 10, {}, 5.0 ); // $ExpectError - random( 10, ( x: number ): number => x, 5.0 ); // $ExpectError - - random( 10, '5', 5.0, {} ); // $ExpectError - random( 10, true, 5.0, {} ); // $ExpectError - random( 10, false, 5.0, {} ); // $ExpectError - random( 10, null, 5.0, {} ); // $ExpectError - random( 10, [], 5.0, {} ); // $ExpectError - random( 10, {}, 5.0, {} ); // $ExpectError - random( 10, ( x: number ): number => x, 5.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' ); // $ExpectError - random( 10, 2.0, true ); // $ExpectError - random( 10, 2.0, false ); // $ExpectError - random( 10, 2.0, null ); // $ExpectError - random( 10, 2.0, [] ); // $ExpectError - random( 10, 2.0, {} ); // $ExpectError - random( 10, 2.0, ( x: number ): number => x ); // $ExpectError - - random( 10, 2.0, '5', {} ); // $ExpectError - random( 10, 2.0, true, {} ); // $ExpectError - random( 10, 2.0, false, {} ); // $ExpectError - random( 10, 2.0, null, {} ); // $ExpectError - random( 10, 2.0, [], {} ); // $ExpectError - random( 10, 2.0, {}, {} ); // $ExpectError - random( 10, 2.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, '5' ); // $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, [] ); // $ExpectError - random( 10, 2.0, 5.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, { 'dtype': 123 } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': null } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - random( 10, 2.0, 5.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 -} - -// Attached to main export is a `factory` method which returns a function... -{ - random.factory( 2.0, 5.0 ); // $ExpectType UnaryFunction - random.factory( 2.0, 5.0, { 'copy': false } ); // $ExpectType UnaryFunction - - random.factory(); // $ExpectType TernaryFunction - random.factory( { 'copy': false } ); // $ExpectType TernaryFunction -} - -// The `factory` method returns a function which returns an array... -{ - const fcn1 = random.factory( 2.0, 5.0 ); - fcn1( 10 ); // $ExpectType RandomArray - - const fcn2 = random.factory(); - fcn2( 10, 2.0, 5.0 ); // $ExpectType RandomArray -} - -// The compiler throws an error if the `factory` method is provided invalid arguments... -{ - random.factory( '5', 5.0 ); // $ExpectError - random.factory( true, 5.0 ); // $ExpectError - random.factory( false, 5.0 ); // $ExpectError - random.factory( [], 5.0 ); // $ExpectError - random.factory( {}, 5.0 ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0 ); // $ExpectError - - random.factory( '5', 5.0, {} ); // $ExpectError - random.factory( true, 5.0, {} ); // $ExpectError - random.factory( false, 5.0, {} ); // $ExpectError - random.factory( [], 5.0, {} ); // $ExpectError - random.factory( {}, 5.0, {} ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0, {} ); // $ExpectError - - random.factory( 2.0, '5' ); // $ExpectError - random.factory( 2.0, true ); // $ExpectError - random.factory( 2.0, false ); // $ExpectError - random.factory( 2.0, [] ); // $ExpectError - random.factory( 2.0, {} ); // $ExpectError - random.factory( 2.0, ( x: number ): number => x ); // $ExpectError - - random.factory( 2.0, '5', {} ); // $ExpectError - random.factory( 2.0, true, {} ); // $ExpectError - random.factory( 2.0, false, {} ); // $ExpectError - random.factory( 2.0, [], {} ); // $ExpectError - random.factory( 2.0, {}, {} ); // $ExpectError - random.factory( 2.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, 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, { 'prng': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'seed': true } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': [ 'a' ] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'state': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': {} } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': true ); // $ExpectError - random.factory( 2.0, 5.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, { 'copy': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'dtype': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - random.factory( 2.0, 5.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, {}, {} ); // $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 ); - 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 ); // $ExpectError - fcn2( false, 2.0, 5.0 ); // $ExpectError - fcn2( '5', 2.0, 5.0 ); // $ExpectError - fcn2( [], 2.0, 5.0 ); // $ExpectError - fcn2( {}, 2.0, 5.0 ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - fcn2( true, 2.0, 5.0, {} ); // $ExpectError - fcn2( false, 2.0, 5.0, {} ); // $ExpectError - fcn2( '5', 2.0, 5.0, {} ); // $ExpectError - fcn2( [], 2.0, 5.0, {} ); // $ExpectError - fcn2( {}, 2.0, 5.0, {} ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0, {} ); // $ExpectError - - fcn2( 10, true, 5.0 ); // $ExpectError - fcn2( 10, false, 5.0 ); // $ExpectError - fcn2( 10, '5', 5.0 ); // $ExpectError - fcn2( 10, [], 5.0 ); // $ExpectError - fcn2( 10, {}, 5.0 ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0 ); // $ExpectError - - fcn2( 10, true, 5.0, {} ); // $ExpectError - fcn2( 10, false, 5.0, {} ); // $ExpectError - fcn2( 10, '5', 5.0, {} ); // $ExpectError - fcn2( 10, [], 5.0, {} ); // $ExpectError - fcn2( 10, {}, 5.0, {} ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0, {} ); // $ExpectError - - fcn2( 10, 2.0, true ); // $ExpectError - fcn2( 10, 2.0, false ); // $ExpectError - fcn2( 10, 2.0, '5' ); // $ExpectError - fcn2( 10, 2.0, [] ); // $ExpectError - fcn2( 10, 2.0, {} ); // $ExpectError - fcn2( 10, 2.0, ( x: number ): number => x ); // $ExpectError - - fcn2( 10, 2.0, true, {} ); // $ExpectError - fcn2( 10, 2.0, false, {} ); // $ExpectError - fcn2( 10, 2.0, '5', {} ); // $ExpectError - fcn2( 10, 2.0, [], {} ); // $ExpectError - fcn2( 10, 2.0, {}, {} ); // $ExpectError - fcn2( 10, 2.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, { 'dtype': 123 } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': null } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError - - const fcn2 = random.factory( 2.0, 5.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 ); - fcn1(); // $ExpectError - fcn1( 1, 1, 1 ); // $ExpectError - - const fcn2 = random.factory(); - fcn2(); // $ExpectError - fcn2( 1 ); // $ExpectError - fcn2( 1, 1, 1, 1 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index c485546..0000000 --- a/examples/index.js +++ /dev/null @@ -1,48 +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'; - -var logEach = require( '@stdlib/console-log-each' ); -var uniform = require( './../lib' ); - -// Create a function for generating random arrays originating from the same state: -var random = uniform.factory( 2.0, 5.0, { - 'state': uniform.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 = uniform.factory( 2.0, 5.0, { - 'state': uniform.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 6fef7d9..e49ce72 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { FloatDataType, 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..411d38d --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.1.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-accessor@v0.1.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-write-accessor@v0.1.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-constant-function@v0.1.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-noop@v0.1.1-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/random-base-uniform@v0.1.0-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-typed-real-float-ctors@v0.1.0-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@v0.1.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-nullary@v0.1.0-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@v0.1.0-esm/index.mjs";import f from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.1.1-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/array-typed-real-float-dtypes@v0.1.1-esm/index.mjs";import h from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.1.0-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.1.1-esm/index.mjs";var c="float64",u=a();function g(e,t){return h(t)?j(t,"dtype")&&(e.dtype=t.dtype,u.indexOf(e.dtype)<0)?new TypeError(f("1eR2X,3g,4S,GD,Gg,Jm","dtype",u.join('", "'),e.dtype)):null:new TypeError(f("1eR2V,FD",t))}function v(){var a,h,j,u,v,y;if(j={dtype:c},0===(h=arguments.length))v=d,u=x;else if(1===h){if(a=arguments[0],v=d.factory(a),y=g(j,a))throw y;u=x}else if(2===h)v=d.factory(arguments[0],arguments[1]),u=b;else if(3===h){if(a=arguments[2],v=d.factory(arguments[0],arguments[1],a),y=g(j,a))throw y;u=b}return a&&a.prng?(e(u,"seed",null),e(u,"seedLength",null),n(u,"state",r(null),i),e(u,"stateLength",null),e(u,"byteLength",null)):(s(u,"seed",w),s(u,"seedLength",G),n(u,"state",N,P),s(u,"stateLength",R),s(u,"byteLength",L)),e(u,"PRNG",v.PRNG),u;function b(e,s){var n,r,i,d;if(!t(e))throw new TypeError(f("1eR2d,MG",e));if(d={},arguments.length>1&&(r=g(d,s)))throw r;return"generic"===(i=d.dtype||j.dtype)?l(e,v):(n=new(o(i))(e),m([n],[e],[1],v),n)}function x(e,s,n,r){var i,d,m,a;if(!t(e))throw new TypeError(f("1eR2d,MG",e));if(a={},arguments.length>3&&(d=g(a,r)))throw d;return"generic"===(m=a.dtype||j.dtype)?l(e,h):(i=new(o(m))(e),p([[s],[n],i],[e],[0,0,1],v),i);function h(){return v(s,n)}}function w(){return u.PRNG.seed}function G(){return u.PRNG.seedLength}function R(){return u.PRNG.stateLength}function L(){return u.PRNG.byteLength}function N(){return u.PRNG.state}function P(e){u.PRNG.state=e}}u.push("generic");var y=v();e(y,"factory",v);export{y as default,v as factory}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..f442194 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/factory.js","../lib/main.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 dtypes from '@stdlib/array-typed-real-float-dtypes';\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes();\nDTYPES.push( 'generic' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '1eR2V,FD', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( DTYPES.indexOf( opts.dtype ) < 0 ) {\n\t\t\treturn new TypeError( format( '1eR2X,3g,4S,GD,Gg,Jm', 'dtype', DTYPES.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport setReadOnlyAccessor from '@stdlib/utils-define-nonenumerable-read-only-accessor';\nimport setReadWriteAccessor from '@stdlib/utils-define-nonenumerable-read-write-accessor';\nimport constantFunction from '@stdlib/utils-constant-function';\nimport noop from '@stdlib/utils-noop';\nimport base from '@stdlib/random-base-uniform';\nimport ctors from '@stdlib/array-typed-real-float-ctors';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport nullary from '@stdlib/strided-base-nullary';\nimport binary from '@stdlib/strided-base-binary';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution.\n*\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\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 {RangeError} `a` must be less than `b`\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 uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10 );\n* // returns \n*\n* @example\n* var uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nfunction factory() {\n\tvar options;\n\tvar nargs;\n\tvar opts;\n\tvar rand;\n\tvar prng;\n\tvar err;\n\n\topts = {\n\t\t'dtype': defaults.dtype\n\t};\n\n\tnargs = arguments.length;\n\tif ( nargs === 0 ) {\n\t\tprng = base;\n\t\trand = uniform2;\n\t} else if ( nargs === 1 ) {\n\t\toptions = arguments[ 0 ];\n\t\tprng = base.factory( options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform2;\n\t} else if ( nargs === 2 ) {\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ] );\n\t\trand = uniform1;\n\t} else if ( nargs === 3 ) {\n\t\toptions = arguments[ 2 ];\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ], options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform1;\n\t}\n\tif ( options && options.prng ) {\n\t\tsetReadOnly( rand, 'seed', null );\n\t\tsetReadOnly( rand, 'seedLength', null );\n\t\tsetReadWriteAccessor( rand, 'state', constantFunction( null ), noop );\n\t\tsetReadOnly( rand, 'stateLength', null );\n\t\tsetReadOnly( rand, 'byteLength', null );\n\t} else {\n\t\tsetReadOnlyAccessor( rand, 'seed', getSeed );\n\t\tsetReadOnlyAccessor( rand, 'seedLength', getSeedLength );\n\t\tsetReadWriteAccessor( rand, 'state', getState, setState );\n\t\tsetReadOnlyAccessor( rand, 'stateLength', getStateLength );\n\t\tsetReadOnlyAccessor( rand, 'byteLength', getStateSize );\n\t}\n\tsetReadOnly( rand, 'PRNG', prng.PRNG );\n\treturn rand;\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform1( len, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( '1eR2d,MG', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 1 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, prng );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tnullary( [ out ], [ len ], [ 1 ], prng );\n\t\treturn out;\n\t}\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {number} a - minimum support\n\t* @param {number} b - maximum support\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform2( len, a, b, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( '1eR2d,MG', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 3 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\t// NOTE: we could alternatively use the PRNG factory function to create a PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. Decision made here to avoid this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom number. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in a return value of `NaN`.\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, wrapper );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tbinary( [ [ a ], [ b ], out ], [ len ], [ 0, 0, 1 ], prng );\n\t\treturn out;\n\n\t\t/**\n\t\t* Applies parameters to a pseudorandom number generator function.\n\t\t*\n\t\t* @private\n\t\t* @returns {number} pseudorandom number\n\t\t*/\n\t\tfunction wrapper() {\n\t\t\treturn prng( a, b );\n\t\t}\n\t}\n\n\t/**\n\t* Returns the PRNG seed.\n\t*\n\t* @private\n\t* @returns {PRNGSeedMT19937} seed\n\t*/\n\tfunction getSeed() {\n\t\treturn rand.PRNG.seed;\n\t}\n\n\t/**\n\t* Returns the PRNG seed length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} seed length\n\t*/\n\tfunction getSeedLength() {\n\t\treturn rand.PRNG.seedLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state length\n\t*/\n\tfunction getStateLength() {\n\t\treturn rand.PRNG.stateLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state size (in bytes).\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state size (in bytes)\n\t*/\n\tfunction getStateSize() {\n\t\treturn rand.PRNG.byteLength;\n\t}\n\n\t/**\n\t* Returns the current pseudorandom number generator state.\n\t*\n\t* @private\n\t* @returns {PRNGStateMT19937} current state\n\t*/\n\tfunction getState() {\n\t\treturn rand.PRNG.state;\n\t}\n\n\t/**\n\t* Sets the pseudorandom number generator state.\n\t*\n\t* @private\n\t* @param {PRNGStateMT19937} s - generator state\n\t* @throws {Error} must provide a valid state\n\t*/\n\tfunction setState( s ) {\n\t\trand.PRNG.state = s;\n\t}\n}\n\n\n// EXPORTS //\n\nexport default factory;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @name uniform\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\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 = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar uniform = factory();\n\n\n// EXPORTS //\n\nexport default uniform;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @module @stdlib/random-array-uniform\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.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\" }\n"],"names":["DTYPES","dtypes","validate","opts","options","isObject","hasOwnProp","dtype","indexOf","TypeError","format","join","factory","nargs","rand","prng","err","defaults","arguments","length","base","uniform2","uniform1","setReadOnly","setReadWriteAccessor","constantFunction","noop","setReadOnlyAccessor","getSeed","getSeedLength","getState","setState","getStateLength","getStateSize","PRNG","len","out","dt","o","isNonNegativeInteger","filledBy","ctors","nullary","a","b","wrapper","binary","seed","seedLength","stateLength","byteLength","state","s","push","uniform","main"],"mappings":";;ohDA8BIA,EAASC,IAyBb,SAASC,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,WACzBD,EAAKI,MAAQH,EAAQG,MAChBP,EAAOQ,QAASL,EAAKI,OAAU,GAC5B,IAAIE,UAAWC,EAAQ,uBAAwB,QAASV,EAAOW,KAAM,QAAUR,EAAKI,QAGtF,KARC,IAAIE,UAAWC,EAAQ,WAAYN,GAS5C,CCSA,SAASQ,IACR,IAAIR,EACAS,EACAV,EACAW,EACAC,EACAC,EAOJ,GALAb,EAAO,CACNI,MAASU,GAIK,KADfJ,EAAQK,UAAUC,QAEjBJ,EAAOK,EACPN,EAAOO,OACD,GAAe,IAAVR,EAAc,CAIzB,GAHAT,EAAUc,UAAW,GACrBH,EAAOK,EAAKR,QAASR,GACrBY,EAAMd,EAAUC,EAAMC,GAErB,MAAMY,EAEPF,EAAOO,CACT,MAAQ,GAAe,IAAVR,EACXE,EAAOK,EAAKR,QAASM,UAAW,GAAKA,UAAW,IAChDJ,EAAOQ,OACD,GAAe,IAAVT,EAAc,CAIzB,GAHAT,EAAUc,UAAW,GACrBH,EAAOK,EAAKR,QAASM,UAAW,GAAKA,UAAW,GAAKd,GACrDY,EAAMd,EAAUC,EAAMC,GAErB,MAAMY,EAEPF,EAAOQ,CACP,CAeD,OAdKlB,GAAWA,EAAQW,MACvBQ,EAAaT,EAAM,OAAQ,MAC3BS,EAAaT,EAAM,aAAc,MACjCU,EAAsBV,EAAM,QAASW,EAAkB,MAAQC,GAC/DH,EAAaT,EAAM,cAAe,MAClCS,EAAaT,EAAM,aAAc,QAEjCa,EAAqBb,EAAM,OAAQc,GACnCD,EAAqBb,EAAM,aAAce,GACzCL,EAAsBV,EAAM,QAASgB,EAAUC,GAC/CJ,EAAqBb,EAAM,cAAekB,GAC1CL,EAAqBb,EAAM,aAAcmB,IAE1CV,EAAaT,EAAM,OAAQC,EAAKmB,MACzBpB,EAcP,SAASQ,EAAUa,EAAK/B,GACvB,IACIgC,EACApB,EACAqB,EACAC,EACJ,IAAMC,EAAsBJ,GAC3B,MAAM,IAAI1B,UAAWC,EAAQ,WAAYyB,IAG1C,GADAG,EAAI,CAAA,EACCpB,UAAUC,OAAS,IACvBH,EAAMd,EAAUoC,EAAGlC,IAElB,MAAMY,EAIR,MAAY,aADZqB,EAAKC,EAAE/B,OAASJ,EAAKI,OAEbiC,EAAUL,EAAKpB,IAGvBqB,EAAM,IADCK,EAAOJ,GACR,CAAUF,GAChBO,EAAS,CAAEN,GAAO,CAAED,GAAO,CAAE,GAAKpB,GAC3BqB,EACP,CAgBD,SAASf,EAAUc,EAAKQ,EAAGC,EAAGxC,GAC7B,IACIgC,EACApB,EACAqB,EACAC,EACJ,IAAMC,EAAsBJ,GAC3B,MAAM,IAAI1B,UAAWC,EAAQ,WAAYyB,IAG1C,GADAG,EAAI,CAAA,EACCpB,UAAUC,OAAS,IACvBH,EAAMd,EAAUoC,EAAGlC,IAElB,MAAMY,EAKR,MAAY,aADZqB,EAAKC,EAAE/B,OAASJ,EAAKI,OAEbiC,EAAUL,EAAKU,IAGvBT,EAAM,IADCK,EAAOJ,GACR,CAAUF,GAChBW,EAAQ,CAAE,CAAEH,GAAK,CAAEC,GAAKR,GAAO,CAAED,GAAO,CAAE,EAAG,EAAG,GAAKpB,GAC9CqB,GAQP,SAASS,IACR,OAAO9B,EAAM4B,EAAGC,EAChB,CACD,CAQD,SAAShB,IACR,OAAOd,EAAKoB,KAAKa,IACjB,CAQD,SAASlB,IACR,OAAOf,EAAKoB,KAAKc,UACjB,CAQD,SAAShB,IACR,OAAOlB,EAAKoB,KAAKe,WACjB,CAQD,SAAShB,IACR,OAAOnB,EAAKoB,KAAKgB,UACjB,CAQD,SAASpB,IACR,OAAOhB,EAAKoB,KAAKiB,KACjB,CASD,SAASpB,EAAUqB,GAClBtC,EAAKoB,KAAKiB,MAAQC,CAClB,CACF,CDrPApD,EAAOqD,KAAM,WEqBV,IAACC,EAAU1C,ICiBdW,EAAAgC,EAAA,UAAA3C"} \ No newline at end of file diff --git a/lib/defaults.json b/lib/defaults.json deleted file mode 100644 index 83f4438..0000000 --- a/lib/defaults.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "dtype": "float64" -} diff --git a/lib/factory.js b/lib/factory.js deleted file mode 100644 index 24d5d10..0000000 --- a/lib/factory.js +++ /dev/null @@ -1,282 +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 isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var setReadOnlyAccessor = require( '@stdlib/utils-define-nonenumerable-read-only-accessor' ); -var setReadWriteAccessor = require( '@stdlib/utils-define-nonenumerable-read-write-accessor' ); -var constantFunction = require( '@stdlib/utils-constant-function' ); -var noop = require( '@stdlib/utils-noop' ); -var base = require( '@stdlib/random-base-uniform' ); -var ctors = require( '@stdlib/array-typed-real-float-ctors' ); -var filledBy = require( '@stdlib/array-base-filled-by' ); -var nullary = require( '@stdlib/strided-base-nullary' ); -var binary = require( '@stdlib/strided-base-binary' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution. -* -* @param {number} [a] - minimum support -* @param {number} [b] - maximum support -* @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 {RangeError} `a` must be less than `b` -* @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 uniform = factory( 2.0, 5.0 ); -* // returns -* -* var arr = uniform( 10 ); -* // returns -* -* @example -* var uniform = factory( 2.0, 5.0 ); -* // returns -* -* var arr = uniform( 10, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -function factory() { - var options; - var nargs; - var opts; - var rand; - var prng; - var err; - - opts = { - 'dtype': defaults.dtype - }; - - nargs = arguments.length; - if ( nargs === 0 ) { - prng = base; - rand = uniform2; - } else if ( nargs === 1 ) { - options = arguments[ 0 ]; - prng = base.factory( options ); - err = validate( opts, options ); - if ( err ) { - throw err; - } - rand = uniform2; - } else if ( nargs === 2 ) { - prng = base.factory( arguments[ 0 ], arguments[ 1 ] ); - rand = uniform1; - } else if ( nargs === 3 ) { - options = arguments[ 2 ]; - prng = base.factory( arguments[ 0 ], arguments[ 1 ], options ); - err = validate( opts, options ); - if ( err ) { - throw err; - } - rand = uniform1; - } - if ( options && options.prng ) { - setReadOnly( rand, 'seed', null ); - setReadOnly( rand, 'seedLength', null ); - setReadWriteAccessor( rand, 'state', constantFunction( null ), noop ); - setReadOnly( rand, 'stateLength', null ); - setReadOnly( rand, 'byteLength', null ); - } else { - setReadOnlyAccessor( rand, 'seed', getSeed ); - setReadOnlyAccessor( rand, 'seedLength', getSeedLength ); - setReadWriteAccessor( rand, 'state', getState, setState ); - setReadOnlyAccessor( rand, 'stateLength', getStateLength ); - setReadOnlyAccessor( rand, 'byteLength', getStateSize ); - } - setReadOnly( rand, 'PRNG', prng.PRNG ); - return rand; - - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @private - * @param {NonNegativeInteger} len - array length - * @param {Options} [options] - function options - * @param {string} [options.dtype] - 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 - */ - function uniform1( len, options ) { - var ctor; - var out; - var err; - var dt; - var o; - if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( '1eR2d,MG', len ) ); - } - o = {}; - if ( arguments.length > 1 ) { - err = validate( o, options ); - if ( err ) { - throw err; - } - } - dt = o.dtype || opts.dtype; - if ( dt === 'generic' ) { - return filledBy( len, prng ); - } - ctor = ctors( dt ); - out = new ctor( len ); - nullary( [ out ], [ len ], [ 1 ], prng ); - return out; - } - - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @private - * @param {NonNegativeInteger} len - array length - * @param {number} a - minimum support - * @param {number} b - maximum support - * @param {Options} [options] - function options - * @param {string} [options.dtype] - 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 - */ - function uniform2( len, a, b, options ) { - var ctor; - var out; - var err; - var dt; - var o; - if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( '1eR2d,MG', len ) ); - } - o = {}; - if ( arguments.length > 3 ) { - err = validate( o, options ); - if ( err ) { - throw err; - } - } - // NOTE: we could alternatively use the PRNG factory function to create a PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. Decision made here to avoid this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom number. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in a return value of `NaN`. - dt = o.dtype || opts.dtype; - if ( dt === 'generic' ) { - return filledBy( len, wrapper ); - } - ctor = ctors( dt ); - out = new ctor( len ); - binary( [ [ a ], [ b ], out ], [ len ], [ 0, 0, 1 ], prng ); - return out; - - /** - * Applies parameters to a pseudorandom number generator function. - * - * @private - * @returns {number} pseudorandom number - */ - function wrapper() { - return prng( a, b ); - } - } - - /** - * Returns the PRNG seed. - * - * @private - * @returns {PRNGSeedMT19937} seed - */ - function getSeed() { - return rand.PRNG.seed; - } - - /** - * Returns the PRNG seed length. - * - * @private - * @returns {PositiveInteger} seed length - */ - function getSeedLength() { - return rand.PRNG.seedLength; - } - - /** - * Returns the PRNG state length. - * - * @private - * @returns {PositiveInteger} state length - */ - function getStateLength() { - return rand.PRNG.stateLength; - } - - /** - * Returns the PRNG state size (in bytes). - * - * @private - * @returns {PositiveInteger} state size (in bytes) - */ - function getStateSize() { - return rand.PRNG.byteLength; - } - - /** - * Returns the current pseudorandom number generator state. - * - * @private - * @returns {PRNGStateMT19937} current state - */ - function getState() { - return rand.PRNG.state; - } - - /** - * Sets the pseudorandom number generator state. - * - * @private - * @param {PRNGStateMT19937} s - generator state - * @throws {Error} must provide a valid state - */ - function setState( s ) { - rand.PRNG.state = s; - } -} - - -// EXPORTS // - -module.exports = factory; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 0077f00..0000000 --- a/lib/index.js +++ /dev/null @@ -1,77 +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'; - -/** -* Create an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. -* -* @module @stdlib/random-array-uniform -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var arr = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var arr = uniform( 10, 2.0, 5.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var rand = uniform.factory( 2.0, 5.0 ); -* // returns -* -* var arr = rand( 10 ); -* // returns -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var rand = uniform.factory( 2.0, 5.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" } diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index da0d9b1..0000000 --- a/lib/main.js +++ /dev/null @@ -1,58 +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 factory = require( './factory.js' ); - - -// MAIN // - -/** -* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. -* -* @name uniform -* @type {Function} -* @param {NonNegativeInteger} len - array length -* @param {number} a - minimum support -* @param {number} b - maximum support -* @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 = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var arr = uniform( 10, 2.0, 5.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -var uniform = factory(); - - -// EXPORTS // - -module.exports = uniform; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index 1c3d511..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,72 +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 dtypes = require( '@stdlib/array-typed-real-float-dtypes' ); -var isObject = require( '@stdlib/assert-is-plain-object' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// VARIABLES // - -var DTYPES = dtypes(); -DTYPES.push( 'generic' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Options} options - function options -* @param {string} [options.dtype] - output array data type -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var options = { -* 'dtype': 'float64' -* }; -* var err = validate( opts, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( '1eR2V,FD', options ) ); - } - if ( hasOwnProp( options, 'dtype' ) ) { - opts.dtype = options.dtype; - if ( DTYPES.indexOf( opts.dtype ) < 0 ) { - return new TypeError( format( '1eR2X,3g,4S,GD,Gg,Jm', 'dtype', DTYPES.join( '", "' ), opts.dtype ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index 0b325cb..767a213 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 continuous uniform 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,55 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-filled-by": "^0.1.0", - "@stdlib/array-typed-real-float-ctors": "^0.1.0", - "@stdlib/array-typed-real-float-dtypes": "^0.1.1", - "@stdlib/assert-has-own-property": "^0.1.1", - "@stdlib/assert-is-nonnegative-integer": "^0.1.0", - "@stdlib/assert-is-plain-object": "^0.1.1", - "@stdlib/random-base-uniform": "^0.1.0", - "@stdlib/strided-base-binary": "^0.1.0", - "@stdlib/strided-base-nullary": "^0.1.0", - "@stdlib/error-tools-fmtprodmsg": "^0.1.1", - "@stdlib/types": "^0.2.0", - "@stdlib/utils-constant-function": "^0.1.1", - "@stdlib/utils-define-nonenumerable-read-only-accessor": "^0.1.1", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1", - "@stdlib/utils-define-nonenumerable-read-write-accessor": "^0.1.1", - "@stdlib/utils-noop": "^0.1.1" - }, - "devDependencies": { - "@stdlib/array-float32": "^0.1.1", - "@stdlib/array-float64": "^0.1.1", - "@stdlib/array-uint32": "^0.1.1", - "@stdlib/assert-is-uint32array": "^0.1.1", - "@stdlib/bench": "^0.2.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" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdmath", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..a513bae --- /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.factory.js b/test/test.factory.js deleted file mode 100644 index a869e75..0000000 --- a/test/test.factory.js +++ /dev/null @@ -1,1328 +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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -tape( 'the function throws an error if the second distribution parameter is less than the first distribution parameter', function test( t ) { - var values; - var i; - - values = [ - [ 0.0, 0.0 ], - [ -2.0, -4.0 ], - [ 2.0, 1.0 ] - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( arr ) { - return function badValue() { - factory( arr[0], arr[1] ); - }; - } -}); - -tape( 'the function throws an error if the second distribution parameter is less than the first distribution parameter (options)', function test( t ) { - var values; - var i; - - values = [ - [ 0.0, 0.0 ], - [ -2.0, -4.0 ], - [ 2.0, 1.0 ] - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( arr ) { - return function badValue() { - factory( arr[0], arr[1], {} ); - }; - } -}); - -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, 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, { - '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, { - '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, { - '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, { - '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, { - '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, { - '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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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 ); - - 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 ); - - 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, { - '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 ); - - 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 ); - 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( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory(); - actual = random( 10, 2.0, 5.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( typeof actual[ i ], 'number', '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 ); - - 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 ); - - 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 ); - - 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 that generates `NaN` values if the first distribution parameter is greater than or equal to the second distribution parameter', function test( t ) { - var random; - var values; - var actual; - var i; - var j; - - random = factory(); - values = [ - [ 2.0, 1.0 ], - [ -3.0, -4.0 ], - [ 0.0, 0.0 ] - ]; - - for ( i = 0; i < values.length; i++ ) { - actual = random( 10, values[ i ][ 0 ], values[ i ][ 1 ] ); - for ( j = 0; j < actual.length; j++ ) { - t.strictEqual( isnan( actual[ j ] ), true, 'returns expected value when provided '+values[ 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, { - '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 ); - - 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, { - '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( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'float64' - }); - actual = random( 10, 2.0, 5.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( typeof actual[ i ], 'number', '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, { - '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( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'float32' - }); - actual = random( 10, 2.0, 5.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( typeof actual[ i ], 'number', '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, { - '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 ); - - 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, { - '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, { - '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 ); - - // 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, { - '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 ); - - // 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, { - '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 ); - - 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, { - 'prng': randu.normalized - }); - - randu = minstd.factory({ - 'seed': seed - }); - random2 = factory( 2.0, 5.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 ); - arr2 = random2( 10, 2.0, 5.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 c4fb6d3..0000000 --- a/test/test.js +++ /dev/null @@ -1,69 +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 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 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 37b0080..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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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, 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, { - '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 ); - - 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( typeof actual[ i ], 'number', '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, { - '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( typeof actual[ i ], 'number', '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, { - '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( typeof actual[ i ], 'number', '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, { - '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 ); - } - // Capture the current state: - state = random.state; - - // Move to a future state... - arr = random( 10, 2.0, 5.0 ); - for ( i = 0; i < 100; i++ ) { - random( 2, 2.0, 5.0 ); - } - // Set the state: - random.state = state; - - // Replay previously generated values: - t.deepEqual( random( 10, 2.0, 5.0 ), arr, 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.validate.js b/test/test.validate.js deleted file mode 100644 index 9fbe15f..0000000 --- a/test/test.validate.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 validate = require( './../lib/validate.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof validate, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function returns an error if provided an options argument which is not an object', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - void 0, - null, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, values[ i ] ); - t.equal( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided a `dtype` option which is not a supported data type', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - -5, - NaN, - true, - false, - void 0, - null, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, { - 'dtype': values[ i ] - }); - t.equal( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns null if all options are valid', function test( t ) { - var options; - var opts; - var err; - - options = { - 'dtype': 'float64' - }; - opts = {}; - err = validate( opts, options ); - - t.equal( err, null, 'returns null' ); - t.deepEqual( opts, options, 'sets option values' ); - - t.end(); -}); - -tape( 'the function ignores unrecognized/unsupported options', function test( t ) { - var options; - var opts; - var err; - - options = { - 'beep': true, - 'boop': 'bop' - }; - opts = {}; - err = validate( opts, options ); - - t.equal( err, null, 'returns null' ); - t.deepEqual( opts, {}, 'does not set any option values' ); - t.end(); -}); From 1ca1045a137eaa4d58d2685c99040431b6f7374a Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 8 Dec 2023 04:13:25 +0000 Subject: [PATCH 43/82] Transform error messages --- lib/factory.js | 6 +++--- lib/validate.js | 6 +++--- package.json | 2 +- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/lib/factory.js b/lib/factory.js index 22ec236..24d5d10 100644 --- a/lib/factory.js +++ b/lib/factory.js @@ -31,7 +31,7 @@ var ctors = require( '@stdlib/array-typed-real-float-ctors' ); var filledBy = require( '@stdlib/array-base-filled-by' ); var nullary = require( '@stdlib/strided-base-nullary' ); var binary = require( '@stdlib/strided-base-binary' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var defaults = require( './defaults.json' ); var validate = require( './validate.js' ); @@ -144,7 +144,7 @@ function factory() { var dt; var o; if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) ); + throw new TypeError( format( '1eR2d,MG', len ) ); } o = {}; if ( arguments.length > 1 ) { @@ -184,7 +184,7 @@ function factory() { var dt; var o; if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) ); + throw new TypeError( format( '1eR2d,MG', len ) ); } o = {}; if ( arguments.length > 3 ) { diff --git a/lib/validate.js b/lib/validate.js index 40b9723..1c3d511 100644 --- a/lib/validate.js +++ b/lib/validate.js @@ -23,7 +23,7 @@ var dtypes = require( '@stdlib/array-typed-real-float-dtypes' ); var isObject = require( '@stdlib/assert-is-plain-object' ); var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // VARIABLES // @@ -55,12 +55,12 @@ DTYPES.push( 'generic' ); */ function validate( opts, options ) { if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); + return new TypeError( format( '1eR2V,FD', options ) ); } if ( hasOwnProp( options, 'dtype' ) ) { opts.dtype = options.dtype; if ( DTYPES.indexOf( opts.dtype ) < 0 ) { - return new TypeError( format( 'invalid option. `%s` option must be one of the following: "%s". Option: `%s`.', 'dtype', DTYPES.join( '", "' ), opts.dtype ) ); + return new TypeError( format( '1eR2X,3g,4S,GD,Gg,Jm', 'dtype', DTYPES.join( '", "' ), opts.dtype ) ); } } return null; diff --git a/package.json b/package.json index f38cc33..0b325cb 100644 --- a/package.json +++ b/package.json @@ -46,7 +46,7 @@ "@stdlib/random-base-uniform": "^0.1.0", "@stdlib/strided-base-binary": "^0.1.0", "@stdlib/strided-base-nullary": "^0.1.0", - "@stdlib/string-format": "^0.1.1", + "@stdlib/error-tools-fmtprodmsg": "^0.1.1", "@stdlib/types": "^0.2.0", "@stdlib/utils-constant-function": "^0.1.1", "@stdlib/utils-define-nonenumerable-read-only-accessor": "^0.1.1", From f37211507568d4942743558d39b2a5dd740f41e0 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 8 Dec 2023 04:15:30 +0000 Subject: [PATCH 44/82] Remove files --- index.d.ts | 245 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6427 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 e49ce72..0000000 --- a/index.d.ts +++ /dev/null @@ -1,245 +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. -*/ - -// TypeScript Version: 4.1 - -/// - -import { FloatDataType, FloatTypedArray } from '@stdlib/types/array'; -import * as random from '@stdlib/types/random'; - -/** -* Supported data types. -*/ -type DataType = FloatDataType | 'generic'; - -/** -* 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 continuous uniform distribution with pre-specified parameter values. -*/ -interface UnaryFunction extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @param len - array length - * @param options - function options - * @returns output array - */ - ( len: number, options?: Options ): RandomArray; -} - -/** -* Interface for generating pseudorandom numbers drawn from a continuous uniform distribution without pre-specified parameter values. -*/ -interface TernaryFunction extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @param len - array length - * @param a - minimum support - * @param b - maximum support - * @param options - function options - * @returns output array - */ - ( len: number, a: number, b: number, options?: Options ): RandomArray; -} - -/** -* Interface for generating pseudorandom numbers drawn from a uniform distribution. -*/ -interface Random extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @param len - array length - * @param a - minimum support - * @param b - maximum support - * @param options - function options - * @returns output array - * - * @example - * var out = uniform( 10, 2.0, 5.0 ); - * // returns - */ - ( len: number, a: number, b: number, options?: Options ): RandomArray; - - /** - * Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution. - * - * ## Notes - * - * - When provided `a` and `b`, the returned function returns random variates drawn from the specified distribution. - * - * @param a - minimum support - * @param b - maximum support - * @param options - function options - * @throws `a` must be less than `b` - * @throws must provide a valid state - * @returns function for creating arrays - * - * @example - * var random = uniform.factory( 2.0, 5.0 ); - * - * var out = random( 10 ); - * // returns - * - * @example - * var random = uniform.factory( 2.0, 5.0, { - * 'seed': 297 - * }); - * var out = random( 10 ); - * // returns - */ - factory( a: number, b: number, options?: FactoryOptions ): UnaryFunction; - - /** - * Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution. - * - * ## Notes - * - * - When not provided `a` and `b`, the returned function requires that both `a` and `b` be provided at each invocation. - * - * @param options - function options - * @throws must provide a valid state - * @returns function for creating arrays - * - * @example - * var random = uniform.factory(); - * - * var out = random( 10, 2.0, 5.0 ); - * // returns - * - * @example - * var random = uniform.factory({ - * 'seed': 297 - * }); - * var out = random( 10, 2.0, 5.0 ); - * // returns - */ - factory( options?: FactoryOptions ): TernaryFunction; -} - -/** -* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. -* -* @param len - array length -* @param a - minimum support -* @param b - maximum support -* @param options - function options -* @returns output array -* -* @example -* var out = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var random = uniform.factory( 2.0, 5.0 ); -* -* var out = random( 10 ); -* // returns -*/ -declare var uniform: Random; - - -// EXPORTS // - -export = uniform; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 411d38d..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.1.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-accessor@v0.1.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-write-accessor@v0.1.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-constant-function@v0.1.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-noop@v0.1.1-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/random-base-uniform@v0.1.0-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-typed-real-float-ctors@v0.1.0-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@v0.1.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-nullary@v0.1.0-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@v0.1.0-esm/index.mjs";import f from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.1.1-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/array-typed-real-float-dtypes@v0.1.1-esm/index.mjs";import h from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.1.0-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.1.1-esm/index.mjs";var c="float64",u=a();function g(e,t){return h(t)?j(t,"dtype")&&(e.dtype=t.dtype,u.indexOf(e.dtype)<0)?new TypeError(f("1eR2X,3g,4S,GD,Gg,Jm","dtype",u.join('", "'),e.dtype)):null:new TypeError(f("1eR2V,FD",t))}function v(){var a,h,j,u,v,y;if(j={dtype:c},0===(h=arguments.length))v=d,u=x;else if(1===h){if(a=arguments[0],v=d.factory(a),y=g(j,a))throw y;u=x}else if(2===h)v=d.factory(arguments[0],arguments[1]),u=b;else if(3===h){if(a=arguments[2],v=d.factory(arguments[0],arguments[1],a),y=g(j,a))throw y;u=b}return a&&a.prng?(e(u,"seed",null),e(u,"seedLength",null),n(u,"state",r(null),i),e(u,"stateLength",null),e(u,"byteLength",null)):(s(u,"seed",w),s(u,"seedLength",G),n(u,"state",N,P),s(u,"stateLength",R),s(u,"byteLength",L)),e(u,"PRNG",v.PRNG),u;function b(e,s){var n,r,i,d;if(!t(e))throw new TypeError(f("1eR2d,MG",e));if(d={},arguments.length>1&&(r=g(d,s)))throw r;return"generic"===(i=d.dtype||j.dtype)?l(e,v):(n=new(o(i))(e),m([n],[e],[1],v),n)}function x(e,s,n,r){var i,d,m,a;if(!t(e))throw new TypeError(f("1eR2d,MG",e));if(a={},arguments.length>3&&(d=g(a,r)))throw d;return"generic"===(m=a.dtype||j.dtype)?l(e,h):(i=new(o(m))(e),p([[s],[n],i],[e],[0,0,1],v),i);function h(){return v(s,n)}}function w(){return u.PRNG.seed}function G(){return u.PRNG.seedLength}function R(){return u.PRNG.stateLength}function L(){return u.PRNG.byteLength}function N(){return u.PRNG.state}function P(e){u.PRNG.state=e}}u.push("generic");var y=v();e(y,"factory",v);export{y as default,v as factory}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index f442194..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/factory.js","../lib/main.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 dtypes from '@stdlib/array-typed-real-float-dtypes';\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes();\nDTYPES.push( 'generic' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '1eR2V,FD', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( DTYPES.indexOf( opts.dtype ) < 0 ) {\n\t\t\treturn new TypeError( format( '1eR2X,3g,4S,GD,Gg,Jm', 'dtype', DTYPES.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport setReadOnlyAccessor from '@stdlib/utils-define-nonenumerable-read-only-accessor';\nimport setReadWriteAccessor from '@stdlib/utils-define-nonenumerable-read-write-accessor';\nimport constantFunction from '@stdlib/utils-constant-function';\nimport noop from '@stdlib/utils-noop';\nimport base from '@stdlib/random-base-uniform';\nimport ctors from '@stdlib/array-typed-real-float-ctors';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport nullary from '@stdlib/strided-base-nullary';\nimport binary from '@stdlib/strided-base-binary';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution.\n*\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\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 {RangeError} `a` must be less than `b`\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 uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10 );\n* // returns \n*\n* @example\n* var uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nfunction factory() {\n\tvar options;\n\tvar nargs;\n\tvar opts;\n\tvar rand;\n\tvar prng;\n\tvar err;\n\n\topts = {\n\t\t'dtype': defaults.dtype\n\t};\n\n\tnargs = arguments.length;\n\tif ( nargs === 0 ) {\n\t\tprng = base;\n\t\trand = uniform2;\n\t} else if ( nargs === 1 ) {\n\t\toptions = arguments[ 0 ];\n\t\tprng = base.factory( options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform2;\n\t} else if ( nargs === 2 ) {\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ] );\n\t\trand = uniform1;\n\t} else if ( nargs === 3 ) {\n\t\toptions = arguments[ 2 ];\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ], options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform1;\n\t}\n\tif ( options && options.prng ) {\n\t\tsetReadOnly( rand, 'seed', null );\n\t\tsetReadOnly( rand, 'seedLength', null );\n\t\tsetReadWriteAccessor( rand, 'state', constantFunction( null ), noop );\n\t\tsetReadOnly( rand, 'stateLength', null );\n\t\tsetReadOnly( rand, 'byteLength', null );\n\t} else {\n\t\tsetReadOnlyAccessor( rand, 'seed', getSeed );\n\t\tsetReadOnlyAccessor( rand, 'seedLength', getSeedLength );\n\t\tsetReadWriteAccessor( rand, 'state', getState, setState );\n\t\tsetReadOnlyAccessor( rand, 'stateLength', getStateLength );\n\t\tsetReadOnlyAccessor( rand, 'byteLength', getStateSize );\n\t}\n\tsetReadOnly( rand, 'PRNG', prng.PRNG );\n\treturn rand;\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform1( len, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( '1eR2d,MG', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 1 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, prng );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tnullary( [ out ], [ len ], [ 1 ], prng );\n\t\treturn out;\n\t}\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {number} a - minimum support\n\t* @param {number} b - maximum support\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform2( len, a, b, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( '1eR2d,MG', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 3 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\t// NOTE: we could alternatively use the PRNG factory function to create a PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. Decision made here to avoid this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom number. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in a return value of `NaN`.\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, wrapper );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tbinary( [ [ a ], [ b ], out ], [ len ], [ 0, 0, 1 ], prng );\n\t\treturn out;\n\n\t\t/**\n\t\t* Applies parameters to a pseudorandom number generator function.\n\t\t*\n\t\t* @private\n\t\t* @returns {number} pseudorandom number\n\t\t*/\n\t\tfunction wrapper() {\n\t\t\treturn prng( a, b );\n\t\t}\n\t}\n\n\t/**\n\t* Returns the PRNG seed.\n\t*\n\t* @private\n\t* @returns {PRNGSeedMT19937} seed\n\t*/\n\tfunction getSeed() {\n\t\treturn rand.PRNG.seed;\n\t}\n\n\t/**\n\t* Returns the PRNG seed length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} seed length\n\t*/\n\tfunction getSeedLength() {\n\t\treturn rand.PRNG.seedLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state length\n\t*/\n\tfunction getStateLength() {\n\t\treturn rand.PRNG.stateLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state size (in bytes).\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state size (in bytes)\n\t*/\n\tfunction getStateSize() {\n\t\treturn rand.PRNG.byteLength;\n\t}\n\n\t/**\n\t* Returns the current pseudorandom number generator state.\n\t*\n\t* @private\n\t* @returns {PRNGStateMT19937} current state\n\t*/\n\tfunction getState() {\n\t\treturn rand.PRNG.state;\n\t}\n\n\t/**\n\t* Sets the pseudorandom number generator state.\n\t*\n\t* @private\n\t* @param {PRNGStateMT19937} s - generator state\n\t* @throws {Error} must provide a valid state\n\t*/\n\tfunction setState( s ) {\n\t\trand.PRNG.state = s;\n\t}\n}\n\n\n// EXPORTS //\n\nexport default factory;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @name uniform\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\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 = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar uniform = factory();\n\n\n// EXPORTS //\n\nexport default uniform;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @module @stdlib/random-array-uniform\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.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\" }\n"],"names":["DTYPES","dtypes","validate","opts","options","isObject","hasOwnProp","dtype","indexOf","TypeError","format","join","factory","nargs","rand","prng","err","defaults","arguments","length","base","uniform2","uniform1","setReadOnly","setReadWriteAccessor","constantFunction","noop","setReadOnlyAccessor","getSeed","getSeedLength","getState","setState","getStateLength","getStateSize","PRNG","len","out","dt","o","isNonNegativeInteger","filledBy","ctors","nullary","a","b","wrapper","binary","seed","seedLength","stateLength","byteLength","state","s","push","uniform","main"],"mappings":";;ohDA8BIA,EAASC,IAyBb,SAASC,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,WACzBD,EAAKI,MAAQH,EAAQG,MAChBP,EAAOQ,QAASL,EAAKI,OAAU,GAC5B,IAAIE,UAAWC,EAAQ,uBAAwB,QAASV,EAAOW,KAAM,QAAUR,EAAKI,QAGtF,KARC,IAAIE,UAAWC,EAAQ,WAAYN,GAS5C,CCSA,SAASQ,IACR,IAAIR,EACAS,EACAV,EACAW,EACAC,EACAC,EAOJ,GALAb,EAAO,CACNI,MAASU,GAIK,KADfJ,EAAQK,UAAUC,QAEjBJ,EAAOK,EACPN,EAAOO,OACD,GAAe,IAAVR,EAAc,CAIzB,GAHAT,EAAUc,UAAW,GACrBH,EAAOK,EAAKR,QAASR,GACrBY,EAAMd,EAAUC,EAAMC,GAErB,MAAMY,EAEPF,EAAOO,CACT,MAAQ,GAAe,IAAVR,EACXE,EAAOK,EAAKR,QAASM,UAAW,GAAKA,UAAW,IAChDJ,EAAOQ,OACD,GAAe,IAAVT,EAAc,CAIzB,GAHAT,EAAUc,UAAW,GACrBH,EAAOK,EAAKR,QAASM,UAAW,GAAKA,UAAW,GAAKd,GACrDY,EAAMd,EAAUC,EAAMC,GAErB,MAAMY,EAEPF,EAAOQ,CACP,CAeD,OAdKlB,GAAWA,EAAQW,MACvBQ,EAAaT,EAAM,OAAQ,MAC3BS,EAAaT,EAAM,aAAc,MACjCU,EAAsBV,EAAM,QAASW,EAAkB,MAAQC,GAC/DH,EAAaT,EAAM,cAAe,MAClCS,EAAaT,EAAM,aAAc,QAEjCa,EAAqBb,EAAM,OAAQc,GACnCD,EAAqBb,EAAM,aAAce,GACzCL,EAAsBV,EAAM,QAASgB,EAAUC,GAC/CJ,EAAqBb,EAAM,cAAekB,GAC1CL,EAAqBb,EAAM,aAAcmB,IAE1CV,EAAaT,EAAM,OAAQC,EAAKmB,MACzBpB,EAcP,SAASQ,EAAUa,EAAK/B,GACvB,IACIgC,EACApB,EACAqB,EACAC,EACJ,IAAMC,EAAsBJ,GAC3B,MAAM,IAAI1B,UAAWC,EAAQ,WAAYyB,IAG1C,GADAG,EAAI,CAAA,EACCpB,UAAUC,OAAS,IACvBH,EAAMd,EAAUoC,EAAGlC,IAElB,MAAMY,EAIR,MAAY,aADZqB,EAAKC,EAAE/B,OAASJ,EAAKI,OAEbiC,EAAUL,EAAKpB,IAGvBqB,EAAM,IADCK,EAAOJ,GACR,CAAUF,GAChBO,EAAS,CAAEN,GAAO,CAAED,GAAO,CAAE,GAAKpB,GAC3BqB,EACP,CAgBD,SAASf,EAAUc,EAAKQ,EAAGC,EAAGxC,GAC7B,IACIgC,EACApB,EACAqB,EACAC,EACJ,IAAMC,EAAsBJ,GAC3B,MAAM,IAAI1B,UAAWC,EAAQ,WAAYyB,IAG1C,GADAG,EAAI,CAAA,EACCpB,UAAUC,OAAS,IACvBH,EAAMd,EAAUoC,EAAGlC,IAElB,MAAMY,EAKR,MAAY,aADZqB,EAAKC,EAAE/B,OAASJ,EAAKI,OAEbiC,EAAUL,EAAKU,IAGvBT,EAAM,IADCK,EAAOJ,GACR,CAAUF,GAChBW,EAAQ,CAAE,CAAEH,GAAK,CAAEC,GAAKR,GAAO,CAAED,GAAO,CAAE,EAAG,EAAG,GAAKpB,GAC9CqB,GAQP,SAASS,IACR,OAAO9B,EAAM4B,EAAGC,EAChB,CACD,CAQD,SAAShB,IACR,OAAOd,EAAKoB,KAAKa,IACjB,CAQD,SAASlB,IACR,OAAOf,EAAKoB,KAAKc,UACjB,CAQD,SAAShB,IACR,OAAOlB,EAAKoB,KAAKe,WACjB,CAQD,SAAShB,IACR,OAAOnB,EAAKoB,KAAKgB,UACjB,CAQD,SAASpB,IACR,OAAOhB,EAAKoB,KAAKiB,KACjB,CASD,SAASpB,EAAUqB,GAClBtC,EAAKoB,KAAKiB,MAAQC,CAClB,CACF,CDrPApD,EAAOqD,KAAM,WEqBV,IAACC,EAAU1C,ICiBdW,EAAAgC,EAAA,UAAA3C"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index a513bae..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 24fa6c3a3b8448a29ce2a162ce3ad4e7f880f98e Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 8 Dec 2023 04:18:00 +0000 Subject: [PATCH 45/82] 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 | 227 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 65 +- benchmark/benchmark.float32.factory.js | 96 - benchmark/benchmark.float32.js | 98 - benchmark/benchmark.float64.factory.js | 96 - benchmark/benchmark.float64.js | 98 - benchmark/benchmark.generic.factory.js | 96 - benchmark/benchmark.generic.js | 98 - branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 9 - dist/index.js.map | 7 - docs/repl.txt | 169 - docs/types/test.ts | 355 -- examples/index.js | 48 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/defaults.json | 3 - lib/factory.js | 282 - lib/index.js | 77 - lib/main.js | 58 - lib/validate.js | 72 - package.json | 76 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.factory.js | 1328 ----- test/test.js | 69 - test/test.main.js | 244 - test/test.validate.js | 118 - 52 files changed, 6217 insertions(+), 6780 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 benchmark/benchmark.float32.factory.js delete mode 100644 benchmark/benchmark.float32.js delete mode 100644 benchmark/benchmark.float64.factory.js delete mode 100644 benchmark/benchmark.float64.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/defaults.json delete mode 100644 lib/factory.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.factory.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js delete mode 100644 test/test.validate.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 c4ab52b..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/uniform) 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 5097056..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/uniform) 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 ea152a8..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: '33 9 * * 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 corresponding to v3.0.3: - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 - 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 + + ```
@@ -383,7 +382,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]. @@ -443,19 +442,19 @@ Copyright © 2016-2023. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/random-array-uniform/main/LICENSE -[@stdlib/random/base/uniform]: https://github.com/stdlib-js/random-base-uniform +[@stdlib/random/base/uniform]: https://github.com/stdlib-js/random-base-uniform/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 -[@stdlib/random/array/discrete-uniform]: https://github.com/stdlib-js/random-array-discrete-uniform +[@stdlib/random/array/discrete-uniform]: https://github.com/stdlib-js/random-array-discrete-uniform/tree/esm -[@stdlib/random/strided/uniform]: https://github.com/stdlib-js/random-strided-uniform +[@stdlib/random/strided/uniform]: https://github.com/stdlib-js/random-strided-uniform/tree/esm diff --git a/benchmark/benchmark.float32.factory.js b/benchmark/benchmark.float32.factory.js deleted file mode 100644 index 67e61f4..0000000 --- a/benchmark/benchmark.float32.factory.js +++ /dev/null @@ -1,96 +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 bench = require( '@stdlib/bench' ); -var isnanf = require( '@stdlib/math-base-assert-is-nanf' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var fcn = uniform.factory( 2.0, 5.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 4642816..0000000 --- a/benchmark/benchmark.float32.js +++ /dev/null @@ -1,98 +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 bench = require( '@stdlib/bench' ); -var isnanf = require( '@stdlib/math-base-assert-is-nanf' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = 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 = uniform( len, 2.0, 5.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.factory.js b/benchmark/benchmark.float64.factory.js deleted file mode 100644 index 8646a54..0000000 --- a/benchmark/benchmark.float64.factory.js +++ /dev/null @@ -1,96 +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 bench = require( '@stdlib/bench' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var fcn = uniform.factory( 2.0, 5.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 5ee0d97..0000000 --- a/benchmark/benchmark.float64.js +++ /dev/null @@ -1,98 +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 bench = require( '@stdlib/bench' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = 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 = uniform( len, 2.0, 5.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.factory.js b/benchmark/benchmark.generic.factory.js deleted file mode 100644 index 7020d62..0000000 --- a/benchmark/benchmark.generic.factory.js +++ /dev/null @@ -1,96 +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 bench = require( '@stdlib/bench' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var fcn = uniform.factory( 2.0, 5.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 06a2a83..0000000 --- a/benchmark/benchmark.generic.js +++ /dev/null @@ -1,98 +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 bench = require( '@stdlib/bench' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var pkg = require( './../package.json' ).name; -var uniform = 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 = uniform( len, 2.0, 5.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 30542fb..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/uniform" -%% click B href "https://github.com/stdlib-js/random-array-uniform/tree/main" -%% click C href "https://github.com/stdlib-js/random-array-uniform/tree/production" -%% click D href "https://github.com/stdlib-js/random-array-uniform/tree/esm" -%% click E href "https://github.com/stdlib-js/random-array-uniform/tree/deno" -%% click F href "https://github.com/stdlib-js/random-array-uniform/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/uniform -[production-url]: https://github.com/stdlib-js/random-array-uniform/tree/production -[deno-url]: https://github.com/stdlib-js/random-array-uniform/tree/deno -[umd-url]: https://github.com/stdlib-js/random-array-uniform/tree/umd -[esm-url]: https://github.com/stdlib-js/random-array-uniform/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 f2a679f..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import uniform from '../docs/types/index'; -export = uniform; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 0ef1443..0000000 --- a/dist/index.js +++ /dev/null @@ -1,9 +0,0 @@ -"use strict";var y=function(t,r){return function(){return r||t((r={exports:{}}).exports,r),r.exports}};var b=y(function(ue,H){H.exports={dtype:"float64"}});var O=y(function(se,G){ -var J=require('@stdlib/array-typed-real-float-dtypes/dist'),K=require('@stdlib/assert-is-plain-object/dist'),M=require('@stdlib/assert-has-own-property/dist'),N=require('@stdlib/error-tools-fmtprodmsg/dist'),w=J();w.push("generic");function Q(t,r){return K(r)?M(r,"dtype")&&(t.dtype=r.dtype,w.indexOf(t.dtype)<0)?new TypeError(N('1eR4S',"dtype",w.join('", "'),t.dtype)):null:new TypeError(N('1eR2V',r));}G.exports=Q -});var R=y(function(oe,F){ -var S=require('@stdlib/assert-is-nonnegative-integer/dist').isPrimitive,d=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),l=require('@stdlib/utils-define-nonenumerable-read-only-accessor/dist'),x=require('@stdlib/utils-define-nonenumerable-read-write-accessor/dist'),U=require('@stdlib/utils-constant-function/dist'),X=require('@stdlib/utils-noop/dist'),p=require('@stdlib/random-base-uniform/dist'),E=require('@stdlib/array-typed-real-float-ctors/dist'),T=require('@stdlib/array-base-filled-by/dist'),Z=require('@stdlib/strided-base-nullary/dist'),_=require('@stdlib/strided-base-binary/dist'),j=require('@stdlib/error-tools-fmtprodmsg/dist'),$=b(),m=O();function ee(){var t,r,v,e,a,s;if(v={dtype:$.dtype},r=arguments.length,r===0)a=p,e=P;else if(r===1){if(t=arguments[0],a=p.factory(t),s=m(v,t),s)throw s;e=P}else if(r===2)a=p.factory(arguments[0],arguments[1]),e=L;else if(r===3){if(t=arguments[2],a=p.factory(arguments[0],arguments[1],t),s=m(v,t),s)throw s;e=L}return t&&t.prng?(d(e,"seed",null),d(e,"seedLength",null),x(e,"state",U(null),X),d(e,"stateLength",null),d(e,"byteLength",null)):(l(e,"seed",B),l(e,"seedLength",D),x(e,"state",Y,k),l(e,"stateLength",I),l(e,"byteLength",W)),d(e,"PRNG",a.PRNG),e;function L(n,c){var f,g,o,i,u;if(!S(n))throw new TypeError(j('1eR2d',n));if(u={},arguments.length>1&&(o=m(u,c),o))throw o;return i=u.dtype||v.dtype,i==="generic"?T(n,a):(f=E(i),g=new f(n),Z([g],[n],[1],a),g)}function P(n,c,f,g){var o,i,u,h,q;if(!S(n))throw new TypeError(j('1eR2d',n));if(q={},arguments.length>3&&(u=m(q,g),u))throw u;if(h=q.dtype||v.dtype,h==="generic")return T(n,C);return o=E(h),i=new o(n),_([[c],[f],i],[n],[0,0,1],a),i;function C(){return a(c,f)}}function B(){return e.PRNG.seed}function D(){return e.PRNG.seedLength}function I(){return e.PRNG.stateLength}function W(){return e.PRNG.byteLength}function Y(){return e.PRNG.state}function k(n){e.PRNG.state=n}}F.exports=ee -});var A=y(function(ve,V){ -var re=R(),te=re();V.exports=te -});var ne=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),z=A(),ae=R();ne(z,"factory",ae);module.exports=z; -/** @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 fcb8851..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/defaults.json", "../lib/validate.js", "../lib/factory.js", "../lib/main.js", "../lib/index.js"], - "sourcesContent": ["{\n\t\"dtype\": \"float64\"\n}\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 dtypes = require( '@stdlib/array-typed-real-float-dtypes' );\nvar isObject = require( '@stdlib/assert-is-plain-object' );\nvar hasOwnProp = require( '@stdlib/assert-has-own-property' );\nvar format = require( '@stdlib/string-format' );\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes();\nDTYPES.push( 'generic' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( DTYPES.indexOf( opts.dtype ) < 0 ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be one of the following: \"%s\". Option: `%s`.', 'dtype', DTYPES.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nmodule.exports = validate;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive;\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar setReadOnlyAccessor = require( '@stdlib/utils-define-nonenumerable-read-only-accessor' );\nvar setReadWriteAccessor = require( '@stdlib/utils-define-nonenumerable-read-write-accessor' );\nvar constantFunction = require( '@stdlib/utils-constant-function' );\nvar noop = require( '@stdlib/utils-noop' );\nvar base = require( '@stdlib/random-base-uniform' );\nvar ctors = require( '@stdlib/array-typed-real-float-ctors' );\nvar filledBy = require( '@stdlib/array-base-filled-by' );\nvar nullary = require( '@stdlib/strided-base-nullary' );\nvar binary = require( '@stdlib/strided-base-binary' );\nvar format = require( '@stdlib/string-format' );\nvar defaults = require( './defaults.json' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution.\n*\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\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 {RangeError} `a` must be less than `b`\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 uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10 );\n* // returns \n*\n* @example\n* var uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nfunction factory() {\n\tvar options;\n\tvar nargs;\n\tvar opts;\n\tvar rand;\n\tvar prng;\n\tvar err;\n\n\topts = {\n\t\t'dtype': defaults.dtype\n\t};\n\n\tnargs = arguments.length;\n\tif ( nargs === 0 ) {\n\t\tprng = base;\n\t\trand = uniform2;\n\t} else if ( nargs === 1 ) {\n\t\toptions = arguments[ 0 ];\n\t\tprng = base.factory( options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform2;\n\t} else if ( nargs === 2 ) {\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ] );\n\t\trand = uniform1;\n\t} else if ( nargs === 3 ) {\n\t\toptions = arguments[ 2 ];\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ], options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform1;\n\t}\n\tif ( options && options.prng ) {\n\t\tsetReadOnly( rand, 'seed', null );\n\t\tsetReadOnly( rand, 'seedLength', null );\n\t\tsetReadWriteAccessor( rand, 'state', constantFunction( null ), noop );\n\t\tsetReadOnly( rand, 'stateLength', null );\n\t\tsetReadOnly( rand, 'byteLength', null );\n\t} else {\n\t\tsetReadOnlyAccessor( rand, 'seed', getSeed );\n\t\tsetReadOnlyAccessor( rand, 'seedLength', getSeedLength );\n\t\tsetReadWriteAccessor( rand, 'state', getState, setState );\n\t\tsetReadOnlyAccessor( rand, 'stateLength', getStateLength );\n\t\tsetReadOnlyAccessor( rand, 'byteLength', getStateSize );\n\t}\n\tsetReadOnly( rand, 'PRNG', prng.PRNG );\n\treturn rand;\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform1( len, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 1 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, prng );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tnullary( [ out ], [ len ], [ 1 ], prng );\n\t\treturn out;\n\t}\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {number} a - minimum support\n\t* @param {number} b - maximum support\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform2( len, a, b, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 3 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\t// NOTE: we could alternatively use the PRNG factory function to create a PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. Decision made here to avoid this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom number. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in a return value of `NaN`.\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, wrapper );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tbinary( [ [ a ], [ b ], out ], [ len ], [ 0, 0, 1 ], prng );\n\t\treturn out;\n\n\t\t/**\n\t\t* Applies parameters to a pseudorandom number generator function.\n\t\t*\n\t\t* @private\n\t\t* @returns {number} pseudorandom number\n\t\t*/\n\t\tfunction wrapper() {\n\t\t\treturn prng( a, b );\n\t\t}\n\t}\n\n\t/**\n\t* Returns the PRNG seed.\n\t*\n\t* @private\n\t* @returns {PRNGSeedMT19937} seed\n\t*/\n\tfunction getSeed() {\n\t\treturn rand.PRNG.seed;\n\t}\n\n\t/**\n\t* Returns the PRNG seed length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} seed length\n\t*/\n\tfunction getSeedLength() {\n\t\treturn rand.PRNG.seedLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state length\n\t*/\n\tfunction getStateLength() {\n\t\treturn rand.PRNG.stateLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state size (in bytes).\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state size (in bytes)\n\t*/\n\tfunction getStateSize() {\n\t\treturn rand.PRNG.byteLength;\n\t}\n\n\t/**\n\t* Returns the current pseudorandom number generator state.\n\t*\n\t* @private\n\t* @returns {PRNGStateMT19937} current state\n\t*/\n\tfunction getState() {\n\t\treturn rand.PRNG.state;\n\t}\n\n\t/**\n\t* Sets the pseudorandom number generator state.\n\t*\n\t* @private\n\t* @param {PRNGStateMT19937} s - generator state\n\t* @throws {Error} must provide a valid state\n\t*/\n\tfunction setState( s ) {\n\t\trand.PRNG.state = s;\n\t}\n}\n\n\n// EXPORTS //\n\nmodule.exports = factory;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @name uniform\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\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 = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar uniform = factory();\n\n\n// EXPORTS //\n\nmodule.exports = uniform;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @module @stdlib/random-array-uniform\n*\n* @example\n* var uniform = require( '@stdlib/random-array-uniform' );\n*\n* var arr = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var uniform = require( '@stdlib/random-array-uniform' );\n*\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* var uniform = require( '@stdlib/random-array-uniform' );\n*\n* var rand = uniform.factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* var uniform = require( '@stdlib/random-array-uniform' );\n*\n* var rand = uniform.factory( 2.0, 5.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\" }\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,GAAAC,EAAA,CAAAA,EAAA,SACC,MAAS,SACV,ICFA,IAAAC,EAAAC,EAAA,SAAAC,GAAAC,EAAA,cAsBA,IAAIC,EAAS,QAAS,uCAAwC,EAC1DC,EAAW,QAAS,gCAAiC,EACrDC,EAAa,QAAS,iCAAkC,EACxDC,EAAS,QAAS,uBAAwB,EAK1CC,EAASJ,EAAO,EACpBI,EAAO,KAAM,SAAU,EAwBvB,SAASC,EAAUC,EAAMC,EAAU,CAClC,OAAMN,EAAUM,CAAQ,EAGnBL,EAAYK,EAAS,OAAQ,IACjCD,EAAK,MAAQC,EAAQ,MAChBH,EAAO,QAASE,EAAK,KAAM,EAAI,GAC5B,IAAI,UAAWH,EAAQ,gFAAiF,QAASC,EAAO,KAAM,MAAO,EAAGE,EAAK,KAAM,CAAE,EAGvJ,KARC,IAAI,UAAWH,EAAQ,qEAAsEI,CAAQ,CAAE,CAShH,CAKAR,EAAO,QAAUM,ICvEjB,IAAAG,EAAAC,EAAA,SAAAC,GAAAC,EAAA,cAsBA,IAAIC,EAAuB,QAAS,uCAAwC,EAAE,YAC1EC,EAAc,QAAS,uDAAwD,EAC/EC,EAAsB,QAAS,uDAAwD,EACvFC,EAAuB,QAAS,wDAAyD,EACzFC,EAAmB,QAAS,iCAAkC,EAC9DC,EAAO,QAAS,oBAAqB,EACrCC,EAAO,QAAS,6BAA8B,EAC9CC,EAAQ,QAAS,sCAAuC,EACxDC,EAAW,QAAS,8BAA+B,EACnDC,EAAU,QAAS,8BAA+B,EAClDC,EAAS,QAAS,6BAA8B,EAChDC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IACXC,EAAW,IAwCf,SAASC,IAAU,CAClB,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EAOJ,GALAH,EAAO,CACN,MAASL,EAAS,KACnB,EAEAI,EAAQ,UAAU,OACbA,IAAU,EACdG,EAAOb,EACPY,EAAOG,UACIL,IAAU,EAAI,CAIzB,GAHAD,EAAU,UAAW,CAAE,EACvBI,EAAOb,EAAK,QAASS,CAAQ,EAC7BK,EAAMP,EAAUI,EAAMF,CAAQ,EACzBK,EACJ,MAAMA,EAEPF,EAAOG,CACR,SAAYL,IAAU,EACrBG,EAAOb,EAAK,QAAS,UAAW,CAAE,EAAG,UAAW,CAAE,CAAE,EACpDY,EAAOI,UACIN,IAAU,EAAI,CAIzB,GAHAD,EAAU,UAAW,CAAE,EACvBI,EAAOb,EAAK,QAAS,UAAW,CAAE,EAAG,UAAW,CAAE,EAAGS,CAAQ,EAC7DK,EAAMP,EAAUI,EAAMF,CAAQ,EACzBK,EACJ,MAAMA,EAEPF,EAAOI,CACR,CACA,OAAKP,GAAWA,EAAQ,MACvBd,EAAaiB,EAAM,OAAQ,IAAK,EAChCjB,EAAaiB,EAAM,aAAc,IAAK,EACtCf,EAAsBe,EAAM,QAASd,EAAkB,IAAK,EAAGC,CAAK,EACpEJ,EAAaiB,EAAM,cAAe,IAAK,EACvCjB,EAAaiB,EAAM,aAAc,IAAK,IAEtChB,EAAqBgB,EAAM,OAAQK,CAAQ,EAC3CrB,EAAqBgB,EAAM,aAAcM,CAAc,EACvDrB,EAAsBe,EAAM,QAASO,EAAUC,CAAS,EACxDxB,EAAqBgB,EAAM,cAAeS,CAAe,EACzDzB,EAAqBgB,EAAM,aAAcU,CAAa,GAEvD3B,EAAaiB,EAAM,OAAQC,EAAK,IAAK,EAC9BD,EAcP,SAASI,EAAUO,EAAKd,EAAU,CACjC,IAAIe,EACAC,EACAX,EACAY,EACAC,EACJ,GAAK,CAACjC,EAAsB6B,CAAI,EAC/B,MAAM,IAAI,UAAWlB,EAAQ,+EAAgFkB,CAAI,CAAE,EAGpH,GADAI,EAAI,CAAC,EACA,UAAU,OAAS,IACvBb,EAAMP,EAAUoB,EAAGlB,CAAQ,EACtBK,GACJ,MAAMA,EAIR,OADAY,EAAKC,EAAE,OAAShB,EAAK,MAChBe,IAAO,UACJxB,EAAUqB,EAAKV,CAAK,GAE5BW,EAAOvB,EAAOyB,CAAG,EACjBD,EAAM,IAAID,EAAMD,CAAI,EACpBpB,EAAS,CAAEsB,CAAI,EAAG,CAAEF,CAAI,EAAG,CAAE,CAAE,EAAGV,CAAK,EAChCY,EACR,CAgBA,SAASV,EAAUQ,EAAKK,EAAGC,EAAGpB,EAAU,CACvC,IAAIe,EACAC,EACAX,EACAY,EACAC,EACJ,GAAK,CAACjC,EAAsB6B,CAAI,EAC/B,MAAM,IAAI,UAAWlB,EAAQ,+EAAgFkB,CAAI,CAAE,EAGpH,GADAI,EAAI,CAAC,EACA,UAAU,OAAS,IACvBb,EAAMP,EAAUoB,EAAGlB,CAAQ,EACtBK,GACJ,MAAMA,EAKR,GADAY,EAAKC,EAAE,OAAShB,EAAK,MAChBe,IAAO,UACX,OAAOxB,EAAUqB,EAAKO,CAAQ,EAE/B,OAAAN,EAAOvB,EAAOyB,CAAG,EACjBD,EAAM,IAAID,EAAMD,CAAI,EACpBnB,EAAQ,CAAE,CAAEwB,CAAE,EAAG,CAAEC,CAAE,EAAGJ,CAAI,EAAG,CAAEF,CAAI,EAAG,CAAE,EAAG,EAAG,CAAE,EAAGV,CAAK,EACnDY,EAQP,SAASK,GAAU,CAClB,OAAOjB,EAAMe,EAAGC,CAAE,CACnB,CACD,CAQA,SAASZ,GAAU,CAClB,OAAOL,EAAK,KAAK,IAClB,CAQA,SAASM,GAAgB,CACxB,OAAON,EAAK,KAAK,UAClB,CAQA,SAASS,GAAiB,CACzB,OAAOT,EAAK,KAAK,WAClB,CAQA,SAASU,GAAe,CACvB,OAAOV,EAAK,KAAK,UAClB,CAQA,SAASO,GAAW,CACnB,OAAOP,EAAK,KAAK,KAClB,CASA,SAASQ,EAAUW,EAAI,CACtBnB,EAAK,KAAK,MAAQmB,CACnB,CACD,CAKAtC,EAAO,QAAUe,KCzRjB,IAAAwB,EAAAC,EAAA,SAAAC,GAAAC,EAAA,cAsBA,IAAIC,GAAU,IA8BVC,GAAUD,GAAQ,EAKtBD,EAAO,QAAUE,KCKjB,IAAIC,GAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,GAAU,IAKdF,GAAaC,EAAM,UAAWC,EAAQ,EAKtC,OAAO,QAAUD", - "names": ["require_defaults", "__commonJSMin", "exports", "module", "require_validate", "__commonJSMin", "exports", "module", "dtypes", "isObject", "hasOwnProp", "format", "DTYPES", "validate", "opts", "options", "require_factory", "__commonJSMin", "exports", "module", "isNonNegativeInteger", "setReadOnly", "setReadOnlyAccessor", "setReadWriteAccessor", "constantFunction", "noop", "base", "ctors", "filledBy", "nullary", "binary", "format", "defaults", "validate", "factory", "options", "nargs", "opts", "rand", "prng", "err", "uniform2", "uniform1", "getSeed", "getSeedLength", "getState", "setState", "getStateLength", "getStateSize", "len", "ctor", "out", "dt", "o", "a", "b", "wrapper", "s", "require_main", "__commonJSMin", "exports", "module", "factory", "uniform", "setReadOnly", "main", "factory"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 256216a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,169 +0,0 @@ - -{{alias}}( len, a, b[, options] ) - Returns an array containing pseudorandom numbers drawn from a continuous - uniform distribution. - - Parameters - ---------- - len: integer - Output array length. - - a: number - Minimum support. - - b: number - Maximum support. - - 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 ) - - - -{{alias}}.factory( [a, b, ][options] ) - Returns a function for creating arrays containing pseudorandom numbers drawn - from a continuous uniform distribution. - - If provided `a` and `b`, the returned function returns random variates drawn - from the specified distribution. - - If not provided `a` and `b`, the returned function requires that both `a` - and `b` 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. - - 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 ) - - - // Provide distribution parameters: - > fcn = {{alias}}.factory( 2.0, 5.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 ) - - - // Get a copy of the current state: - > var state = {{alias}}.state - - - > out = {{alias}}( 3, 2.0, 5.0 ) - - > out = {{alias}}( 3, 2.0, 5.0 ) - - - // Set the state: - > {{alias}}.state = state; - - // Regenerate a previous array: - > out = {{alias}}( 3, 2.0, 5.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 a087b98..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,355 +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. -*/ - -import random = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - random( 10, 2, 3 ); // $ExpectType RandomArray - random( 10, 1, 2 ); // $ExpectType RandomArray - random( 10, 1, 2, {} ); // $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 ); // $ExpectError - random( true, 2.0, 5.0 ); // $ExpectError - random( false, 2.0, 5.0 ); // $ExpectError - random( null, 2.0, 5.0 ); // $ExpectError - random( [], 2.0, 5.0 ); // $ExpectError - random( {}, 2.0, 5.0 ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - random( '5', 2.0, 5.0, {} ); // $ExpectError - random( true, 2.0, 5.0, {} ); // $ExpectError - random( false, 2.0, 5.0, {} ); // $ExpectError - random( null, 2.0, 5.0, {} ); // $ExpectError - random( [], 2.0, 5.0, {} ); // $ExpectError - random( {}, 2.0, 5.0, {} ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.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 ); // $ExpectError - random( 10, true, 5.0 ); // $ExpectError - random( 10, false, 5.0 ); // $ExpectError - random( 10, null, 5.0 ); // $ExpectError - random( 10, [], 5.0 ); // $ExpectError - random( 10, {}, 5.0 ); // $ExpectError - random( 10, ( x: number ): number => x, 5.0 ); // $ExpectError - - random( 10, '5', 5.0, {} ); // $ExpectError - random( 10, true, 5.0, {} ); // $ExpectError - random( 10, false, 5.0, {} ); // $ExpectError - random( 10, null, 5.0, {} ); // $ExpectError - random( 10, [], 5.0, {} ); // $ExpectError - random( 10, {}, 5.0, {} ); // $ExpectError - random( 10, ( x: number ): number => x, 5.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' ); // $ExpectError - random( 10, 2.0, true ); // $ExpectError - random( 10, 2.0, false ); // $ExpectError - random( 10, 2.0, null ); // $ExpectError - random( 10, 2.0, [] ); // $ExpectError - random( 10, 2.0, {} ); // $ExpectError - random( 10, 2.0, ( x: number ): number => x ); // $ExpectError - - random( 10, 2.0, '5', {} ); // $ExpectError - random( 10, 2.0, true, {} ); // $ExpectError - random( 10, 2.0, false, {} ); // $ExpectError - random( 10, 2.0, null, {} ); // $ExpectError - random( 10, 2.0, [], {} ); // $ExpectError - random( 10, 2.0, {}, {} ); // $ExpectError - random( 10, 2.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, '5' ); // $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, [] ); // $ExpectError - random( 10, 2.0, 5.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, { 'dtype': 123 } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': null } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - random( 10, 2.0, 5.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 -} - -// Attached to main export is a `factory` method which returns a function... -{ - random.factory( 2.0, 5.0 ); // $ExpectType UnaryFunction - random.factory( 2.0, 5.0, { 'copy': false } ); // $ExpectType UnaryFunction - - random.factory(); // $ExpectType TernaryFunction - random.factory( { 'copy': false } ); // $ExpectType TernaryFunction -} - -// The `factory` method returns a function which returns an array... -{ - const fcn1 = random.factory( 2.0, 5.0 ); - fcn1( 10 ); // $ExpectType RandomArray - - const fcn2 = random.factory(); - fcn2( 10, 2.0, 5.0 ); // $ExpectType RandomArray -} - -// The compiler throws an error if the `factory` method is provided invalid arguments... -{ - random.factory( '5', 5.0 ); // $ExpectError - random.factory( true, 5.0 ); // $ExpectError - random.factory( false, 5.0 ); // $ExpectError - random.factory( [], 5.0 ); // $ExpectError - random.factory( {}, 5.0 ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0 ); // $ExpectError - - random.factory( '5', 5.0, {} ); // $ExpectError - random.factory( true, 5.0, {} ); // $ExpectError - random.factory( false, 5.0, {} ); // $ExpectError - random.factory( [], 5.0, {} ); // $ExpectError - random.factory( {}, 5.0, {} ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0, {} ); // $ExpectError - - random.factory( 2.0, '5' ); // $ExpectError - random.factory( 2.0, true ); // $ExpectError - random.factory( 2.0, false ); // $ExpectError - random.factory( 2.0, [] ); // $ExpectError - random.factory( 2.0, {} ); // $ExpectError - random.factory( 2.0, ( x: number ): number => x ); // $ExpectError - - random.factory( 2.0, '5', {} ); // $ExpectError - random.factory( 2.0, true, {} ); // $ExpectError - random.factory( 2.0, false, {} ); // $ExpectError - random.factory( 2.0, [], {} ); // $ExpectError - random.factory( 2.0, {}, {} ); // $ExpectError - random.factory( 2.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, 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, { 'prng': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'seed': true } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': [ 'a' ] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'state': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': {} } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': true ); // $ExpectError - random.factory( 2.0, 5.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, { 'copy': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'dtype': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - random.factory( 2.0, 5.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, {}, {} ); // $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 ); - 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 ); // $ExpectError - fcn2( false, 2.0, 5.0 ); // $ExpectError - fcn2( '5', 2.0, 5.0 ); // $ExpectError - fcn2( [], 2.0, 5.0 ); // $ExpectError - fcn2( {}, 2.0, 5.0 ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - fcn2( true, 2.0, 5.0, {} ); // $ExpectError - fcn2( false, 2.0, 5.0, {} ); // $ExpectError - fcn2( '5', 2.0, 5.0, {} ); // $ExpectError - fcn2( [], 2.0, 5.0, {} ); // $ExpectError - fcn2( {}, 2.0, 5.0, {} ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0, {} ); // $ExpectError - - fcn2( 10, true, 5.0 ); // $ExpectError - fcn2( 10, false, 5.0 ); // $ExpectError - fcn2( 10, '5', 5.0 ); // $ExpectError - fcn2( 10, [], 5.0 ); // $ExpectError - fcn2( 10, {}, 5.0 ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0 ); // $ExpectError - - fcn2( 10, true, 5.0, {} ); // $ExpectError - fcn2( 10, false, 5.0, {} ); // $ExpectError - fcn2( 10, '5', 5.0, {} ); // $ExpectError - fcn2( 10, [], 5.0, {} ); // $ExpectError - fcn2( 10, {}, 5.0, {} ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0, {} ); // $ExpectError - - fcn2( 10, 2.0, true ); // $ExpectError - fcn2( 10, 2.0, false ); // $ExpectError - fcn2( 10, 2.0, '5' ); // $ExpectError - fcn2( 10, 2.0, [] ); // $ExpectError - fcn2( 10, 2.0, {} ); // $ExpectError - fcn2( 10, 2.0, ( x: number ): number => x ); // $ExpectError - - fcn2( 10, 2.0, true, {} ); // $ExpectError - fcn2( 10, 2.0, false, {} ); // $ExpectError - fcn2( 10, 2.0, '5', {} ); // $ExpectError - fcn2( 10, 2.0, [], {} ); // $ExpectError - fcn2( 10, 2.0, {}, {} ); // $ExpectError - fcn2( 10, 2.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, { 'dtype': 123 } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': null } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError - - const fcn2 = random.factory( 2.0, 5.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 ); - fcn1(); // $ExpectError - fcn1( 1, 1, 1 ); // $ExpectError - - const fcn2 = random.factory(); - fcn2(); // $ExpectError - fcn2( 1 ); // $ExpectError - fcn2( 1, 1, 1, 1 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index c485546..0000000 --- a/examples/index.js +++ /dev/null @@ -1,48 +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'; - -var logEach = require( '@stdlib/console-log-each' ); -var uniform = require( './../lib' ); - -// Create a function for generating random arrays originating from the same state: -var random = uniform.factory( 2.0, 5.0, { - 'state': uniform.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 = uniform.factory( 2.0, 5.0, { - 'state': uniform.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 6fef7d9..e49ce72 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { FloatDataType, 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..411d38d --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.1.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-accessor@v0.1.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-write-accessor@v0.1.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-constant-function@v0.1.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-noop@v0.1.1-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/random-base-uniform@v0.1.0-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-typed-real-float-ctors@v0.1.0-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@v0.1.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-nullary@v0.1.0-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@v0.1.0-esm/index.mjs";import f from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.1.1-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/array-typed-real-float-dtypes@v0.1.1-esm/index.mjs";import h from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.1.0-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.1.1-esm/index.mjs";var c="float64",u=a();function g(e,t){return h(t)?j(t,"dtype")&&(e.dtype=t.dtype,u.indexOf(e.dtype)<0)?new TypeError(f("1eR2X,3g,4S,GD,Gg,Jm","dtype",u.join('", "'),e.dtype)):null:new TypeError(f("1eR2V,FD",t))}function v(){var a,h,j,u,v,y;if(j={dtype:c},0===(h=arguments.length))v=d,u=x;else if(1===h){if(a=arguments[0],v=d.factory(a),y=g(j,a))throw y;u=x}else if(2===h)v=d.factory(arguments[0],arguments[1]),u=b;else if(3===h){if(a=arguments[2],v=d.factory(arguments[0],arguments[1],a),y=g(j,a))throw y;u=b}return a&&a.prng?(e(u,"seed",null),e(u,"seedLength",null),n(u,"state",r(null),i),e(u,"stateLength",null),e(u,"byteLength",null)):(s(u,"seed",w),s(u,"seedLength",G),n(u,"state",N,P),s(u,"stateLength",R),s(u,"byteLength",L)),e(u,"PRNG",v.PRNG),u;function b(e,s){var n,r,i,d;if(!t(e))throw new TypeError(f("1eR2d,MG",e));if(d={},arguments.length>1&&(r=g(d,s)))throw r;return"generic"===(i=d.dtype||j.dtype)?l(e,v):(n=new(o(i))(e),m([n],[e],[1],v),n)}function x(e,s,n,r){var i,d,m,a;if(!t(e))throw new TypeError(f("1eR2d,MG",e));if(a={},arguments.length>3&&(d=g(a,r)))throw d;return"generic"===(m=a.dtype||j.dtype)?l(e,h):(i=new(o(m))(e),p([[s],[n],i],[e],[0,0,1],v),i);function h(){return v(s,n)}}function w(){return u.PRNG.seed}function G(){return u.PRNG.seedLength}function R(){return u.PRNG.stateLength}function L(){return u.PRNG.byteLength}function N(){return u.PRNG.state}function P(e){u.PRNG.state=e}}u.push("generic");var y=v();e(y,"factory",v);export{y as default,v as factory}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..f442194 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/factory.js","../lib/main.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 dtypes from '@stdlib/array-typed-real-float-dtypes';\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes();\nDTYPES.push( 'generic' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '1eR2V,FD', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( DTYPES.indexOf( opts.dtype ) < 0 ) {\n\t\t\treturn new TypeError( format( '1eR2X,3g,4S,GD,Gg,Jm', 'dtype', DTYPES.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport setReadOnlyAccessor from '@stdlib/utils-define-nonenumerable-read-only-accessor';\nimport setReadWriteAccessor from '@stdlib/utils-define-nonenumerable-read-write-accessor';\nimport constantFunction from '@stdlib/utils-constant-function';\nimport noop from '@stdlib/utils-noop';\nimport base from '@stdlib/random-base-uniform';\nimport ctors from '@stdlib/array-typed-real-float-ctors';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport nullary from '@stdlib/strided-base-nullary';\nimport binary from '@stdlib/strided-base-binary';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution.\n*\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\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 {RangeError} `a` must be less than `b`\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 uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10 );\n* // returns \n*\n* @example\n* var uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nfunction factory() {\n\tvar options;\n\tvar nargs;\n\tvar opts;\n\tvar rand;\n\tvar prng;\n\tvar err;\n\n\topts = {\n\t\t'dtype': defaults.dtype\n\t};\n\n\tnargs = arguments.length;\n\tif ( nargs === 0 ) {\n\t\tprng = base;\n\t\trand = uniform2;\n\t} else if ( nargs === 1 ) {\n\t\toptions = arguments[ 0 ];\n\t\tprng = base.factory( options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform2;\n\t} else if ( nargs === 2 ) {\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ] );\n\t\trand = uniform1;\n\t} else if ( nargs === 3 ) {\n\t\toptions = arguments[ 2 ];\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ], options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform1;\n\t}\n\tif ( options && options.prng ) {\n\t\tsetReadOnly( rand, 'seed', null );\n\t\tsetReadOnly( rand, 'seedLength', null );\n\t\tsetReadWriteAccessor( rand, 'state', constantFunction( null ), noop );\n\t\tsetReadOnly( rand, 'stateLength', null );\n\t\tsetReadOnly( rand, 'byteLength', null );\n\t} else {\n\t\tsetReadOnlyAccessor( rand, 'seed', getSeed );\n\t\tsetReadOnlyAccessor( rand, 'seedLength', getSeedLength );\n\t\tsetReadWriteAccessor( rand, 'state', getState, setState );\n\t\tsetReadOnlyAccessor( rand, 'stateLength', getStateLength );\n\t\tsetReadOnlyAccessor( rand, 'byteLength', getStateSize );\n\t}\n\tsetReadOnly( rand, 'PRNG', prng.PRNG );\n\treturn rand;\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform1( len, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( '1eR2d,MG', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 1 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, prng );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tnullary( [ out ], [ len ], [ 1 ], prng );\n\t\treturn out;\n\t}\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {number} a - minimum support\n\t* @param {number} b - maximum support\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform2( len, a, b, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( '1eR2d,MG', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 3 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\t// NOTE: we could alternatively use the PRNG factory function to create a PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. Decision made here to avoid this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom number. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in a return value of `NaN`.\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, wrapper );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tbinary( [ [ a ], [ b ], out ], [ len ], [ 0, 0, 1 ], prng );\n\t\treturn out;\n\n\t\t/**\n\t\t* Applies parameters to a pseudorandom number generator function.\n\t\t*\n\t\t* @private\n\t\t* @returns {number} pseudorandom number\n\t\t*/\n\t\tfunction wrapper() {\n\t\t\treturn prng( a, b );\n\t\t}\n\t}\n\n\t/**\n\t* Returns the PRNG seed.\n\t*\n\t* @private\n\t* @returns {PRNGSeedMT19937} seed\n\t*/\n\tfunction getSeed() {\n\t\treturn rand.PRNG.seed;\n\t}\n\n\t/**\n\t* Returns the PRNG seed length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} seed length\n\t*/\n\tfunction getSeedLength() {\n\t\treturn rand.PRNG.seedLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state length\n\t*/\n\tfunction getStateLength() {\n\t\treturn rand.PRNG.stateLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state size (in bytes).\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state size (in bytes)\n\t*/\n\tfunction getStateSize() {\n\t\treturn rand.PRNG.byteLength;\n\t}\n\n\t/**\n\t* Returns the current pseudorandom number generator state.\n\t*\n\t* @private\n\t* @returns {PRNGStateMT19937} current state\n\t*/\n\tfunction getState() {\n\t\treturn rand.PRNG.state;\n\t}\n\n\t/**\n\t* Sets the pseudorandom number generator state.\n\t*\n\t* @private\n\t* @param {PRNGStateMT19937} s - generator state\n\t* @throws {Error} must provide a valid state\n\t*/\n\tfunction setState( s ) {\n\t\trand.PRNG.state = s;\n\t}\n}\n\n\n// EXPORTS //\n\nexport default factory;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @name uniform\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\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 = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar uniform = factory();\n\n\n// EXPORTS //\n\nexport default uniform;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @module @stdlib/random-array-uniform\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.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\" }\n"],"names":["DTYPES","dtypes","validate","opts","options","isObject","hasOwnProp","dtype","indexOf","TypeError","format","join","factory","nargs","rand","prng","err","defaults","arguments","length","base","uniform2","uniform1","setReadOnly","setReadWriteAccessor","constantFunction","noop","setReadOnlyAccessor","getSeed","getSeedLength","getState","setState","getStateLength","getStateSize","PRNG","len","out","dt","o","isNonNegativeInteger","filledBy","ctors","nullary","a","b","wrapper","binary","seed","seedLength","stateLength","byteLength","state","s","push","uniform","main"],"mappings":";;ohDA8BIA,EAASC,IAyBb,SAASC,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,WACzBD,EAAKI,MAAQH,EAAQG,MAChBP,EAAOQ,QAASL,EAAKI,OAAU,GAC5B,IAAIE,UAAWC,EAAQ,uBAAwB,QAASV,EAAOW,KAAM,QAAUR,EAAKI,QAGtF,KARC,IAAIE,UAAWC,EAAQ,WAAYN,GAS5C,CCSA,SAASQ,IACR,IAAIR,EACAS,EACAV,EACAW,EACAC,EACAC,EAOJ,GALAb,EAAO,CACNI,MAASU,GAIK,KADfJ,EAAQK,UAAUC,QAEjBJ,EAAOK,EACPN,EAAOO,OACD,GAAe,IAAVR,EAAc,CAIzB,GAHAT,EAAUc,UAAW,GACrBH,EAAOK,EAAKR,QAASR,GACrBY,EAAMd,EAAUC,EAAMC,GAErB,MAAMY,EAEPF,EAAOO,CACT,MAAQ,GAAe,IAAVR,EACXE,EAAOK,EAAKR,QAASM,UAAW,GAAKA,UAAW,IAChDJ,EAAOQ,OACD,GAAe,IAAVT,EAAc,CAIzB,GAHAT,EAAUc,UAAW,GACrBH,EAAOK,EAAKR,QAASM,UAAW,GAAKA,UAAW,GAAKd,GACrDY,EAAMd,EAAUC,EAAMC,GAErB,MAAMY,EAEPF,EAAOQ,CACP,CAeD,OAdKlB,GAAWA,EAAQW,MACvBQ,EAAaT,EAAM,OAAQ,MAC3BS,EAAaT,EAAM,aAAc,MACjCU,EAAsBV,EAAM,QAASW,EAAkB,MAAQC,GAC/DH,EAAaT,EAAM,cAAe,MAClCS,EAAaT,EAAM,aAAc,QAEjCa,EAAqBb,EAAM,OAAQc,GACnCD,EAAqBb,EAAM,aAAce,GACzCL,EAAsBV,EAAM,QAASgB,EAAUC,GAC/CJ,EAAqBb,EAAM,cAAekB,GAC1CL,EAAqBb,EAAM,aAAcmB,IAE1CV,EAAaT,EAAM,OAAQC,EAAKmB,MACzBpB,EAcP,SAASQ,EAAUa,EAAK/B,GACvB,IACIgC,EACApB,EACAqB,EACAC,EACJ,IAAMC,EAAsBJ,GAC3B,MAAM,IAAI1B,UAAWC,EAAQ,WAAYyB,IAG1C,GADAG,EAAI,CAAA,EACCpB,UAAUC,OAAS,IACvBH,EAAMd,EAAUoC,EAAGlC,IAElB,MAAMY,EAIR,MAAY,aADZqB,EAAKC,EAAE/B,OAASJ,EAAKI,OAEbiC,EAAUL,EAAKpB,IAGvBqB,EAAM,IADCK,EAAOJ,GACR,CAAUF,GAChBO,EAAS,CAAEN,GAAO,CAAED,GAAO,CAAE,GAAKpB,GAC3BqB,EACP,CAgBD,SAASf,EAAUc,EAAKQ,EAAGC,EAAGxC,GAC7B,IACIgC,EACApB,EACAqB,EACAC,EACJ,IAAMC,EAAsBJ,GAC3B,MAAM,IAAI1B,UAAWC,EAAQ,WAAYyB,IAG1C,GADAG,EAAI,CAAA,EACCpB,UAAUC,OAAS,IACvBH,EAAMd,EAAUoC,EAAGlC,IAElB,MAAMY,EAKR,MAAY,aADZqB,EAAKC,EAAE/B,OAASJ,EAAKI,OAEbiC,EAAUL,EAAKU,IAGvBT,EAAM,IADCK,EAAOJ,GACR,CAAUF,GAChBW,EAAQ,CAAE,CAAEH,GAAK,CAAEC,GAAKR,GAAO,CAAED,GAAO,CAAE,EAAG,EAAG,GAAKpB,GAC9CqB,GAQP,SAASS,IACR,OAAO9B,EAAM4B,EAAGC,EAChB,CACD,CAQD,SAAShB,IACR,OAAOd,EAAKoB,KAAKa,IACjB,CAQD,SAASlB,IACR,OAAOf,EAAKoB,KAAKc,UACjB,CAQD,SAAShB,IACR,OAAOlB,EAAKoB,KAAKe,WACjB,CAQD,SAAShB,IACR,OAAOnB,EAAKoB,KAAKgB,UACjB,CAQD,SAASpB,IACR,OAAOhB,EAAKoB,KAAKiB,KACjB,CASD,SAASpB,EAAUqB,GAClBtC,EAAKoB,KAAKiB,MAAQC,CAClB,CACF,CDrPApD,EAAOqD,KAAM,WEqBV,IAACC,EAAU1C,ICiBdW,EAAAgC,EAAA,UAAA3C"} \ No newline at end of file diff --git a/lib/defaults.json b/lib/defaults.json deleted file mode 100644 index 83f4438..0000000 --- a/lib/defaults.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "dtype": "float64" -} diff --git a/lib/factory.js b/lib/factory.js deleted file mode 100644 index 24d5d10..0000000 --- a/lib/factory.js +++ /dev/null @@ -1,282 +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 isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var setReadOnlyAccessor = require( '@stdlib/utils-define-nonenumerable-read-only-accessor' ); -var setReadWriteAccessor = require( '@stdlib/utils-define-nonenumerable-read-write-accessor' ); -var constantFunction = require( '@stdlib/utils-constant-function' ); -var noop = require( '@stdlib/utils-noop' ); -var base = require( '@stdlib/random-base-uniform' ); -var ctors = require( '@stdlib/array-typed-real-float-ctors' ); -var filledBy = require( '@stdlib/array-base-filled-by' ); -var nullary = require( '@stdlib/strided-base-nullary' ); -var binary = require( '@stdlib/strided-base-binary' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution. -* -* @param {number} [a] - minimum support -* @param {number} [b] - maximum support -* @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 {RangeError} `a` must be less than `b` -* @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 uniform = factory( 2.0, 5.0 ); -* // returns -* -* var arr = uniform( 10 ); -* // returns -* -* @example -* var uniform = factory( 2.0, 5.0 ); -* // returns -* -* var arr = uniform( 10, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -function factory() { - var options; - var nargs; - var opts; - var rand; - var prng; - var err; - - opts = { - 'dtype': defaults.dtype - }; - - nargs = arguments.length; - if ( nargs === 0 ) { - prng = base; - rand = uniform2; - } else if ( nargs === 1 ) { - options = arguments[ 0 ]; - prng = base.factory( options ); - err = validate( opts, options ); - if ( err ) { - throw err; - } - rand = uniform2; - } else if ( nargs === 2 ) { - prng = base.factory( arguments[ 0 ], arguments[ 1 ] ); - rand = uniform1; - } else if ( nargs === 3 ) { - options = arguments[ 2 ]; - prng = base.factory( arguments[ 0 ], arguments[ 1 ], options ); - err = validate( opts, options ); - if ( err ) { - throw err; - } - rand = uniform1; - } - if ( options && options.prng ) { - setReadOnly( rand, 'seed', null ); - setReadOnly( rand, 'seedLength', null ); - setReadWriteAccessor( rand, 'state', constantFunction( null ), noop ); - setReadOnly( rand, 'stateLength', null ); - setReadOnly( rand, 'byteLength', null ); - } else { - setReadOnlyAccessor( rand, 'seed', getSeed ); - setReadOnlyAccessor( rand, 'seedLength', getSeedLength ); - setReadWriteAccessor( rand, 'state', getState, setState ); - setReadOnlyAccessor( rand, 'stateLength', getStateLength ); - setReadOnlyAccessor( rand, 'byteLength', getStateSize ); - } - setReadOnly( rand, 'PRNG', prng.PRNG ); - return rand; - - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @private - * @param {NonNegativeInteger} len - array length - * @param {Options} [options] - function options - * @param {string} [options.dtype] - 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 - */ - function uniform1( len, options ) { - var ctor; - var out; - var err; - var dt; - var o; - if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( '1eR2d,MG', len ) ); - } - o = {}; - if ( arguments.length > 1 ) { - err = validate( o, options ); - if ( err ) { - throw err; - } - } - dt = o.dtype || opts.dtype; - if ( dt === 'generic' ) { - return filledBy( len, prng ); - } - ctor = ctors( dt ); - out = new ctor( len ); - nullary( [ out ], [ len ], [ 1 ], prng ); - return out; - } - - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @private - * @param {NonNegativeInteger} len - array length - * @param {number} a - minimum support - * @param {number} b - maximum support - * @param {Options} [options] - function options - * @param {string} [options.dtype] - 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 - */ - function uniform2( len, a, b, options ) { - var ctor; - var out; - var err; - var dt; - var o; - if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( '1eR2d,MG', len ) ); - } - o = {}; - if ( arguments.length > 3 ) { - err = validate( o, options ); - if ( err ) { - throw err; - } - } - // NOTE: we could alternatively use the PRNG factory function to create a PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. Decision made here to avoid this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom number. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in a return value of `NaN`. - dt = o.dtype || opts.dtype; - if ( dt === 'generic' ) { - return filledBy( len, wrapper ); - } - ctor = ctors( dt ); - out = new ctor( len ); - binary( [ [ a ], [ b ], out ], [ len ], [ 0, 0, 1 ], prng ); - return out; - - /** - * Applies parameters to a pseudorandom number generator function. - * - * @private - * @returns {number} pseudorandom number - */ - function wrapper() { - return prng( a, b ); - } - } - - /** - * Returns the PRNG seed. - * - * @private - * @returns {PRNGSeedMT19937} seed - */ - function getSeed() { - return rand.PRNG.seed; - } - - /** - * Returns the PRNG seed length. - * - * @private - * @returns {PositiveInteger} seed length - */ - function getSeedLength() { - return rand.PRNG.seedLength; - } - - /** - * Returns the PRNG state length. - * - * @private - * @returns {PositiveInteger} state length - */ - function getStateLength() { - return rand.PRNG.stateLength; - } - - /** - * Returns the PRNG state size (in bytes). - * - * @private - * @returns {PositiveInteger} state size (in bytes) - */ - function getStateSize() { - return rand.PRNG.byteLength; - } - - /** - * Returns the current pseudorandom number generator state. - * - * @private - * @returns {PRNGStateMT19937} current state - */ - function getState() { - return rand.PRNG.state; - } - - /** - * Sets the pseudorandom number generator state. - * - * @private - * @param {PRNGStateMT19937} s - generator state - * @throws {Error} must provide a valid state - */ - function setState( s ) { - rand.PRNG.state = s; - } -} - - -// EXPORTS // - -module.exports = factory; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 0077f00..0000000 --- a/lib/index.js +++ /dev/null @@ -1,77 +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'; - -/** -* Create an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. -* -* @module @stdlib/random-array-uniform -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var arr = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var arr = uniform( 10, 2.0, 5.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var rand = uniform.factory( 2.0, 5.0 ); -* // returns -* -* var arr = rand( 10 ); -* // returns -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var rand = uniform.factory( 2.0, 5.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" } diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index da0d9b1..0000000 --- a/lib/main.js +++ /dev/null @@ -1,58 +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 factory = require( './factory.js' ); - - -// MAIN // - -/** -* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. -* -* @name uniform -* @type {Function} -* @param {NonNegativeInteger} len - array length -* @param {number} a - minimum support -* @param {number} b - maximum support -* @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 = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var arr = uniform( 10, 2.0, 5.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -var uniform = factory(); - - -// EXPORTS // - -module.exports = uniform; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index 1c3d511..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,72 +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 dtypes = require( '@stdlib/array-typed-real-float-dtypes' ); -var isObject = require( '@stdlib/assert-is-plain-object' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// VARIABLES // - -var DTYPES = dtypes(); -DTYPES.push( 'generic' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Options} options - function options -* @param {string} [options.dtype] - output array data type -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var options = { -* 'dtype': 'float64' -* }; -* var err = validate( opts, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( '1eR2V,FD', options ) ); - } - if ( hasOwnProp( options, 'dtype' ) ) { - opts.dtype = options.dtype; - if ( DTYPES.indexOf( opts.dtype ) < 0 ) { - return new TypeError( format( '1eR2X,3g,4S,GD,Gg,Jm', 'dtype', DTYPES.join( '", "' ), opts.dtype ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index 0b325cb..767a213 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 continuous uniform 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,55 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-filled-by": "^0.1.0", - "@stdlib/array-typed-real-float-ctors": "^0.1.0", - "@stdlib/array-typed-real-float-dtypes": "^0.1.1", - "@stdlib/assert-has-own-property": "^0.1.1", - "@stdlib/assert-is-nonnegative-integer": "^0.1.0", - "@stdlib/assert-is-plain-object": "^0.1.1", - "@stdlib/random-base-uniform": "^0.1.0", - "@stdlib/strided-base-binary": "^0.1.0", - "@stdlib/strided-base-nullary": "^0.1.0", - "@stdlib/error-tools-fmtprodmsg": "^0.1.1", - "@stdlib/types": "^0.2.0", - "@stdlib/utils-constant-function": "^0.1.1", - "@stdlib/utils-define-nonenumerable-read-only-accessor": "^0.1.1", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1", - "@stdlib/utils-define-nonenumerable-read-write-accessor": "^0.1.1", - "@stdlib/utils-noop": "^0.1.1" - }, - "devDependencies": { - "@stdlib/array-float32": "^0.1.1", - "@stdlib/array-float64": "^0.1.1", - "@stdlib/array-uint32": "^0.1.1", - "@stdlib/assert-is-uint32array": "^0.1.1", - "@stdlib/bench": "^0.2.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" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdmath", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..21134c4 --- /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.factory.js b/test/test.factory.js deleted file mode 100644 index a869e75..0000000 --- a/test/test.factory.js +++ /dev/null @@ -1,1328 +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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -tape( 'the function throws an error if the second distribution parameter is less than the first distribution parameter', function test( t ) { - var values; - var i; - - values = [ - [ 0.0, 0.0 ], - [ -2.0, -4.0 ], - [ 2.0, 1.0 ] - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( arr ) { - return function badValue() { - factory( arr[0], arr[1] ); - }; - } -}); - -tape( 'the function throws an error if the second distribution parameter is less than the first distribution parameter (options)', function test( t ) { - var values; - var i; - - values = [ - [ 0.0, 0.0 ], - [ -2.0, -4.0 ], - [ 2.0, 1.0 ] - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( arr ) { - return function badValue() { - factory( arr[0], arr[1], {} ); - }; - } -}); - -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, 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, { - '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, { - '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, { - '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, { - '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, { - '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, { - '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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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 ); - - 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 ); - - 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, { - '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 ); - - 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 ); - 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( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory(); - actual = random( 10, 2.0, 5.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( typeof actual[ i ], 'number', '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 ); - - 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 ); - - 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 ); - - 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 that generates `NaN` values if the first distribution parameter is greater than or equal to the second distribution parameter', function test( t ) { - var random; - var values; - var actual; - var i; - var j; - - random = factory(); - values = [ - [ 2.0, 1.0 ], - [ -3.0, -4.0 ], - [ 0.0, 0.0 ] - ]; - - for ( i = 0; i < values.length; i++ ) { - actual = random( 10, values[ i ][ 0 ], values[ i ][ 1 ] ); - for ( j = 0; j < actual.length; j++ ) { - t.strictEqual( isnan( actual[ j ] ), true, 'returns expected value when provided '+values[ 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, { - '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 ); - - 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, { - '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( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'float64' - }); - actual = random( 10, 2.0, 5.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( typeof actual[ i ], 'number', '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, { - '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( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'float32' - }); - actual = random( 10, 2.0, 5.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( typeof actual[ i ], 'number', '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, { - '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 ); - - 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, { - '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, { - '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 ); - - // 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, { - '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 ); - - // 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, { - '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 ); - - 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, { - 'prng': randu.normalized - }); - - randu = minstd.factory({ - 'seed': seed - }); - random2 = factory( 2.0, 5.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 ); - arr2 = random2( 10, 2.0, 5.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 c4fb6d3..0000000 --- a/test/test.js +++ /dev/null @@ -1,69 +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 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 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 37b0080..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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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, 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, { - '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 ); - - 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( typeof actual[ i ], 'number', '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, { - '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( typeof actual[ i ], 'number', '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, { - '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( typeof actual[ i ], 'number', '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, { - '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 ); - } - // Capture the current state: - state = random.state; - - // Move to a future state... - arr = random( 10, 2.0, 5.0 ); - for ( i = 0; i < 100; i++ ) { - random( 2, 2.0, 5.0 ); - } - // Set the state: - random.state = state; - - // Replay previously generated values: - t.deepEqual( random( 10, 2.0, 5.0 ), arr, 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.validate.js b/test/test.validate.js deleted file mode 100644 index 9fbe15f..0000000 --- a/test/test.validate.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 validate = require( './../lib/validate.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof validate, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function returns an error if provided an options argument which is not an object', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - void 0, - null, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, values[ i ] ); - t.equal( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided a `dtype` option which is not a supported data type', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - -5, - NaN, - true, - false, - void 0, - null, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, { - 'dtype': values[ i ] - }); - t.equal( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns null if all options are valid', function test( t ) { - var options; - var opts; - var err; - - options = { - 'dtype': 'float64' - }; - opts = {}; - err = validate( opts, options ); - - t.equal( err, null, 'returns null' ); - t.deepEqual( opts, options, 'sets option values' ); - - t.end(); -}); - -tape( 'the function ignores unrecognized/unsupported options', function test( t ) { - var options; - var opts; - var err; - - options = { - 'beep': true, - 'boop': 'bop' - }; - opts = {}; - err = validate( opts, options ); - - t.equal( err, null, 'returns null' ); - t.deepEqual( opts, {}, 'does not set any option values' ); - t.end(); -}); From 89b3ed97a2ef1e3af60b1b625c63148a16bee103 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 31 Dec 2023 11:07:30 +0000 Subject: [PATCH 46/82] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index d45b763..69877a6 100644 --- a/package.json +++ b/package.json @@ -46,7 +46,7 @@ "@stdlib/random-base-uniform": "^0.1.0", "@stdlib/strided-base-binary": "^0.1.0", "@stdlib/strided-base-nullary": "^0.1.0", - "@stdlib/string-format": "^0.1.1", + "@stdlib/error-tools-fmtprodmsg": "^0.1.1", "@stdlib/types": "^0.2.0", "@stdlib/utils-constant-function": "^0.1.1", "@stdlib/utils-define-nonenumerable-read-only-accessor": "^0.1.1", From 41681c0de97250ec28371e3d40a2e551024162f5 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 31 Dec 2023 11:20:12 +0000 Subject: [PATCH 47/82] Remove files --- index.d.ts | 245 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6427 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 e49ce72..0000000 --- a/index.d.ts +++ /dev/null @@ -1,245 +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. -*/ - -// TypeScript Version: 4.1 - -/// - -import { FloatDataType, FloatTypedArray } from '@stdlib/types/array'; -import * as random from '@stdlib/types/random'; - -/** -* Supported data types. -*/ -type DataType = FloatDataType | 'generic'; - -/** -* 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 continuous uniform distribution with pre-specified parameter values. -*/ -interface UnaryFunction extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @param len - array length - * @param options - function options - * @returns output array - */ - ( len: number, options?: Options ): RandomArray; -} - -/** -* Interface for generating pseudorandom numbers drawn from a continuous uniform distribution without pre-specified parameter values. -*/ -interface TernaryFunction extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @param len - array length - * @param a - minimum support - * @param b - maximum support - * @param options - function options - * @returns output array - */ - ( len: number, a: number, b: number, options?: Options ): RandomArray; -} - -/** -* Interface for generating pseudorandom numbers drawn from a uniform distribution. -*/ -interface Random extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @param len - array length - * @param a - minimum support - * @param b - maximum support - * @param options - function options - * @returns output array - * - * @example - * var out = uniform( 10, 2.0, 5.0 ); - * // returns - */ - ( len: number, a: number, b: number, options?: Options ): RandomArray; - - /** - * Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution. - * - * ## Notes - * - * - When provided `a` and `b`, the returned function returns random variates drawn from the specified distribution. - * - * @param a - minimum support - * @param b - maximum support - * @param options - function options - * @throws `a` must be less than `b` - * @throws must provide a valid state - * @returns function for creating arrays - * - * @example - * var random = uniform.factory( 2.0, 5.0 ); - * - * var out = random( 10 ); - * // returns - * - * @example - * var random = uniform.factory( 2.0, 5.0, { - * 'seed': 297 - * }); - * var out = random( 10 ); - * // returns - */ - factory( a: number, b: number, options?: FactoryOptions ): UnaryFunction; - - /** - * Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution. - * - * ## Notes - * - * - When not provided `a` and `b`, the returned function requires that both `a` and `b` be provided at each invocation. - * - * @param options - function options - * @throws must provide a valid state - * @returns function for creating arrays - * - * @example - * var random = uniform.factory(); - * - * var out = random( 10, 2.0, 5.0 ); - * // returns - * - * @example - * var random = uniform.factory({ - * 'seed': 297 - * }); - * var out = random( 10, 2.0, 5.0 ); - * // returns - */ - factory( options?: FactoryOptions ): TernaryFunction; -} - -/** -* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. -* -* @param len - array length -* @param a - minimum support -* @param b - maximum support -* @param options - function options -* @returns output array -* -* @example -* var out = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var random = uniform.factory( 2.0, 5.0 ); -* -* var out = random( 10 ); -* // returns -*/ -declare var uniform: Random; - - -// EXPORTS // - -export = uniform; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 411d38d..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.1.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-accessor@v0.1.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-write-accessor@v0.1.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-constant-function@v0.1.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-noop@v0.1.1-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/random-base-uniform@v0.1.0-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-typed-real-float-ctors@v0.1.0-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@v0.1.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-nullary@v0.1.0-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@v0.1.0-esm/index.mjs";import f from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.1.1-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/array-typed-real-float-dtypes@v0.1.1-esm/index.mjs";import h from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.1.0-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.1.1-esm/index.mjs";var c="float64",u=a();function g(e,t){return h(t)?j(t,"dtype")&&(e.dtype=t.dtype,u.indexOf(e.dtype)<0)?new TypeError(f("1eR2X,3g,4S,GD,Gg,Jm","dtype",u.join('", "'),e.dtype)):null:new TypeError(f("1eR2V,FD",t))}function v(){var a,h,j,u,v,y;if(j={dtype:c},0===(h=arguments.length))v=d,u=x;else if(1===h){if(a=arguments[0],v=d.factory(a),y=g(j,a))throw y;u=x}else if(2===h)v=d.factory(arguments[0],arguments[1]),u=b;else if(3===h){if(a=arguments[2],v=d.factory(arguments[0],arguments[1],a),y=g(j,a))throw y;u=b}return a&&a.prng?(e(u,"seed",null),e(u,"seedLength",null),n(u,"state",r(null),i),e(u,"stateLength",null),e(u,"byteLength",null)):(s(u,"seed",w),s(u,"seedLength",G),n(u,"state",N,P),s(u,"stateLength",R),s(u,"byteLength",L)),e(u,"PRNG",v.PRNG),u;function b(e,s){var n,r,i,d;if(!t(e))throw new TypeError(f("1eR2d,MG",e));if(d={},arguments.length>1&&(r=g(d,s)))throw r;return"generic"===(i=d.dtype||j.dtype)?l(e,v):(n=new(o(i))(e),m([n],[e],[1],v),n)}function x(e,s,n,r){var i,d,m,a;if(!t(e))throw new TypeError(f("1eR2d,MG",e));if(a={},arguments.length>3&&(d=g(a,r)))throw d;return"generic"===(m=a.dtype||j.dtype)?l(e,h):(i=new(o(m))(e),p([[s],[n],i],[e],[0,0,1],v),i);function h(){return v(s,n)}}function w(){return u.PRNG.seed}function G(){return u.PRNG.seedLength}function R(){return u.PRNG.stateLength}function L(){return u.PRNG.byteLength}function N(){return u.PRNG.state}function P(e){u.PRNG.state=e}}u.push("generic");var y=v();e(y,"factory",v);export{y as default,v as factory}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index f442194..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/factory.js","../lib/main.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 dtypes from '@stdlib/array-typed-real-float-dtypes';\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes();\nDTYPES.push( 'generic' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '1eR2V,FD', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( DTYPES.indexOf( opts.dtype ) < 0 ) {\n\t\t\treturn new TypeError( format( '1eR2X,3g,4S,GD,Gg,Jm', 'dtype', DTYPES.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport setReadOnlyAccessor from '@stdlib/utils-define-nonenumerable-read-only-accessor';\nimport setReadWriteAccessor from '@stdlib/utils-define-nonenumerable-read-write-accessor';\nimport constantFunction from '@stdlib/utils-constant-function';\nimport noop from '@stdlib/utils-noop';\nimport base from '@stdlib/random-base-uniform';\nimport ctors from '@stdlib/array-typed-real-float-ctors';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport nullary from '@stdlib/strided-base-nullary';\nimport binary from '@stdlib/strided-base-binary';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution.\n*\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\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 {RangeError} `a` must be less than `b`\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 uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10 );\n* // returns \n*\n* @example\n* var uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nfunction factory() {\n\tvar options;\n\tvar nargs;\n\tvar opts;\n\tvar rand;\n\tvar prng;\n\tvar err;\n\n\topts = {\n\t\t'dtype': defaults.dtype\n\t};\n\n\tnargs = arguments.length;\n\tif ( nargs === 0 ) {\n\t\tprng = base;\n\t\trand = uniform2;\n\t} else if ( nargs === 1 ) {\n\t\toptions = arguments[ 0 ];\n\t\tprng = base.factory( options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform2;\n\t} else if ( nargs === 2 ) {\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ] );\n\t\trand = uniform1;\n\t} else if ( nargs === 3 ) {\n\t\toptions = arguments[ 2 ];\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ], options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform1;\n\t}\n\tif ( options && options.prng ) {\n\t\tsetReadOnly( rand, 'seed', null );\n\t\tsetReadOnly( rand, 'seedLength', null );\n\t\tsetReadWriteAccessor( rand, 'state', constantFunction( null ), noop );\n\t\tsetReadOnly( rand, 'stateLength', null );\n\t\tsetReadOnly( rand, 'byteLength', null );\n\t} else {\n\t\tsetReadOnlyAccessor( rand, 'seed', getSeed );\n\t\tsetReadOnlyAccessor( rand, 'seedLength', getSeedLength );\n\t\tsetReadWriteAccessor( rand, 'state', getState, setState );\n\t\tsetReadOnlyAccessor( rand, 'stateLength', getStateLength );\n\t\tsetReadOnlyAccessor( rand, 'byteLength', getStateSize );\n\t}\n\tsetReadOnly( rand, 'PRNG', prng.PRNG );\n\treturn rand;\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform1( len, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( '1eR2d,MG', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 1 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, prng );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tnullary( [ out ], [ len ], [ 1 ], prng );\n\t\treturn out;\n\t}\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {number} a - minimum support\n\t* @param {number} b - maximum support\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform2( len, a, b, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( '1eR2d,MG', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 3 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\t// NOTE: we could alternatively use the PRNG factory function to create a PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. Decision made here to avoid this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom number. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in a return value of `NaN`.\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, wrapper );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tbinary( [ [ a ], [ b ], out ], [ len ], [ 0, 0, 1 ], prng );\n\t\treturn out;\n\n\t\t/**\n\t\t* Applies parameters to a pseudorandom number generator function.\n\t\t*\n\t\t* @private\n\t\t* @returns {number} pseudorandom number\n\t\t*/\n\t\tfunction wrapper() {\n\t\t\treturn prng( a, b );\n\t\t}\n\t}\n\n\t/**\n\t* Returns the PRNG seed.\n\t*\n\t* @private\n\t* @returns {PRNGSeedMT19937} seed\n\t*/\n\tfunction getSeed() {\n\t\treturn rand.PRNG.seed;\n\t}\n\n\t/**\n\t* Returns the PRNG seed length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} seed length\n\t*/\n\tfunction getSeedLength() {\n\t\treturn rand.PRNG.seedLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state length\n\t*/\n\tfunction getStateLength() {\n\t\treturn rand.PRNG.stateLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state size (in bytes).\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state size (in bytes)\n\t*/\n\tfunction getStateSize() {\n\t\treturn rand.PRNG.byteLength;\n\t}\n\n\t/**\n\t* Returns the current pseudorandom number generator state.\n\t*\n\t* @private\n\t* @returns {PRNGStateMT19937} current state\n\t*/\n\tfunction getState() {\n\t\treturn rand.PRNG.state;\n\t}\n\n\t/**\n\t* Sets the pseudorandom number generator state.\n\t*\n\t* @private\n\t* @param {PRNGStateMT19937} s - generator state\n\t* @throws {Error} must provide a valid state\n\t*/\n\tfunction setState( s ) {\n\t\trand.PRNG.state = s;\n\t}\n}\n\n\n// EXPORTS //\n\nexport default factory;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @name uniform\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\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 = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar uniform = factory();\n\n\n// EXPORTS //\n\nexport default uniform;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @module @stdlib/random-array-uniform\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.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\" }\n"],"names":["DTYPES","dtypes","validate","opts","options","isObject","hasOwnProp","dtype","indexOf","TypeError","format","join","factory","nargs","rand","prng","err","defaults","arguments","length","base","uniform2","uniform1","setReadOnly","setReadWriteAccessor","constantFunction","noop","setReadOnlyAccessor","getSeed","getSeedLength","getState","setState","getStateLength","getStateSize","PRNG","len","out","dt","o","isNonNegativeInteger","filledBy","ctors","nullary","a","b","wrapper","binary","seed","seedLength","stateLength","byteLength","state","s","push","uniform","main"],"mappings":";;ohDA8BIA,EAASC,IAyBb,SAASC,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,WACzBD,EAAKI,MAAQH,EAAQG,MAChBP,EAAOQ,QAASL,EAAKI,OAAU,GAC5B,IAAIE,UAAWC,EAAQ,uBAAwB,QAASV,EAAOW,KAAM,QAAUR,EAAKI,QAGtF,KARC,IAAIE,UAAWC,EAAQ,WAAYN,GAS5C,CCSA,SAASQ,IACR,IAAIR,EACAS,EACAV,EACAW,EACAC,EACAC,EAOJ,GALAb,EAAO,CACNI,MAASU,GAIK,KADfJ,EAAQK,UAAUC,QAEjBJ,EAAOK,EACPN,EAAOO,OACD,GAAe,IAAVR,EAAc,CAIzB,GAHAT,EAAUc,UAAW,GACrBH,EAAOK,EAAKR,QAASR,GACrBY,EAAMd,EAAUC,EAAMC,GAErB,MAAMY,EAEPF,EAAOO,CACT,MAAQ,GAAe,IAAVR,EACXE,EAAOK,EAAKR,QAASM,UAAW,GAAKA,UAAW,IAChDJ,EAAOQ,OACD,GAAe,IAAVT,EAAc,CAIzB,GAHAT,EAAUc,UAAW,GACrBH,EAAOK,EAAKR,QAASM,UAAW,GAAKA,UAAW,GAAKd,GACrDY,EAAMd,EAAUC,EAAMC,GAErB,MAAMY,EAEPF,EAAOQ,CACP,CAeD,OAdKlB,GAAWA,EAAQW,MACvBQ,EAAaT,EAAM,OAAQ,MAC3BS,EAAaT,EAAM,aAAc,MACjCU,EAAsBV,EAAM,QAASW,EAAkB,MAAQC,GAC/DH,EAAaT,EAAM,cAAe,MAClCS,EAAaT,EAAM,aAAc,QAEjCa,EAAqBb,EAAM,OAAQc,GACnCD,EAAqBb,EAAM,aAAce,GACzCL,EAAsBV,EAAM,QAASgB,EAAUC,GAC/CJ,EAAqBb,EAAM,cAAekB,GAC1CL,EAAqBb,EAAM,aAAcmB,IAE1CV,EAAaT,EAAM,OAAQC,EAAKmB,MACzBpB,EAcP,SAASQ,EAAUa,EAAK/B,GACvB,IACIgC,EACApB,EACAqB,EACAC,EACJ,IAAMC,EAAsBJ,GAC3B,MAAM,IAAI1B,UAAWC,EAAQ,WAAYyB,IAG1C,GADAG,EAAI,CAAA,EACCpB,UAAUC,OAAS,IACvBH,EAAMd,EAAUoC,EAAGlC,IAElB,MAAMY,EAIR,MAAY,aADZqB,EAAKC,EAAE/B,OAASJ,EAAKI,OAEbiC,EAAUL,EAAKpB,IAGvBqB,EAAM,IADCK,EAAOJ,GACR,CAAUF,GAChBO,EAAS,CAAEN,GAAO,CAAED,GAAO,CAAE,GAAKpB,GAC3BqB,EACP,CAgBD,SAASf,EAAUc,EAAKQ,EAAGC,EAAGxC,GAC7B,IACIgC,EACApB,EACAqB,EACAC,EACJ,IAAMC,EAAsBJ,GAC3B,MAAM,IAAI1B,UAAWC,EAAQ,WAAYyB,IAG1C,GADAG,EAAI,CAAA,EACCpB,UAAUC,OAAS,IACvBH,EAAMd,EAAUoC,EAAGlC,IAElB,MAAMY,EAKR,MAAY,aADZqB,EAAKC,EAAE/B,OAASJ,EAAKI,OAEbiC,EAAUL,EAAKU,IAGvBT,EAAM,IADCK,EAAOJ,GACR,CAAUF,GAChBW,EAAQ,CAAE,CAAEH,GAAK,CAAEC,GAAKR,GAAO,CAAED,GAAO,CAAE,EAAG,EAAG,GAAKpB,GAC9CqB,GAQP,SAASS,IACR,OAAO9B,EAAM4B,EAAGC,EAChB,CACD,CAQD,SAAShB,IACR,OAAOd,EAAKoB,KAAKa,IACjB,CAQD,SAASlB,IACR,OAAOf,EAAKoB,KAAKc,UACjB,CAQD,SAAShB,IACR,OAAOlB,EAAKoB,KAAKe,WACjB,CAQD,SAAShB,IACR,OAAOnB,EAAKoB,KAAKgB,UACjB,CAQD,SAASpB,IACR,OAAOhB,EAAKoB,KAAKiB,KACjB,CASD,SAASpB,EAAUqB,GAClBtC,EAAKoB,KAAKiB,MAAQC,CAClB,CACF,CDrPApD,EAAOqD,KAAM,WEqBV,IAACC,EAAU1C,ICiBdW,EAAAgC,EAAA,UAAA3C"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 21134c4..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 4fdc7dc3a8d89a47aeb5f0f7c882d9c130140163 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 31 Dec 2023 11:20:31 +0000 Subject: [PATCH 48/82] 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 | 65 +- SECURITY.md | 5 - benchmark/benchmark.float32.factory.js | 96 - benchmark/benchmark.float32.js | 98 - benchmark/benchmark.float64.factory.js | 96 - benchmark/benchmark.float64.js | 98 - benchmark/benchmark.generic.factory.js | 96 - benchmark/benchmark.generic.js | 98 - branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 9 - dist/index.js.map | 7 - docs/repl.txt | 169 - docs/types/test.ts | 355 -- examples/index.js | 48 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/defaults.json | 3 - lib/factory.js | 282 - lib/index.js | 77 - lib/main.js | 58 - lib/validate.js | 72 - package.json | 76 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.factory.js | 1328 ----- test/test.js | 69 - test/test.main.js | 244 - test/test.validate.js | 118 - 53 files changed, 6217 insertions(+), 6786 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.factory.js delete mode 100644 benchmark/benchmark.float32.js delete mode 100644 benchmark/benchmark.float64.factory.js delete mode 100644 benchmark/benchmark.float64.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/defaults.json delete mode 100644 lib/factory.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.factory.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js delete mode 100644 test/test.validate.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 c4ab52b..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/uniform) 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 5097056..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/uniform) 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 7f3bcd6..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: '33 9 * * 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 + + ```
@@ -383,7 +382,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]. @@ -443,19 +442,19 @@ Copyright © 2016-2023. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/random-array-uniform/main/LICENSE -[@stdlib/random/base/uniform]: https://github.com/stdlib-js/random-base-uniform +[@stdlib/random/base/uniform]: https://github.com/stdlib-js/random-base-uniform/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 -[@stdlib/random/array/discrete-uniform]: https://github.com/stdlib-js/random-array-discrete-uniform +[@stdlib/random/array/discrete-uniform]: https://github.com/stdlib-js/random-array-discrete-uniform/tree/esm -[@stdlib/random/strided/uniform]: https://github.com/stdlib-js/random-strided-uniform +[@stdlib/random/strided/uniform]: https://github.com/stdlib-js/random-strided-uniform/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.factory.js b/benchmark/benchmark.float32.factory.js deleted file mode 100644 index 62e5ae4..0000000 --- a/benchmark/benchmark.float32.factory.js +++ /dev/null @@ -1,96 +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 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 uniform = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var fcn = uniform.factory( 2.0, 5.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 1c88093..0000000 --- a/benchmark/benchmark.float32.js +++ /dev/null @@ -1,98 +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 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 uniform = 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 = uniform( len, 2.0, 5.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.factory.js b/benchmark/benchmark.float64.factory.js deleted file mode 100644 index 8fe28ee..0000000 --- a/benchmark/benchmark.float64.factory.js +++ /dev/null @@ -1,96 +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 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 uniform = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var fcn = uniform.factory( 2.0, 5.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 65ac42a..0000000 --- a/benchmark/benchmark.float64.js +++ /dev/null @@ -1,98 +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 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 uniform = 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 = uniform( len, 2.0, 5.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.factory.js b/benchmark/benchmark.generic.factory.js deleted file mode 100644 index 3648754..0000000 --- a/benchmark/benchmark.generic.factory.js +++ /dev/null @@ -1,96 +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 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 uniform = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var fcn = uniform.factory( 2.0, 5.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 0582c3e..0000000 --- a/benchmark/benchmark.generic.js +++ /dev/null @@ -1,98 +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 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 uniform = 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 = uniform( len, 2.0, 5.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 30542fb..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/uniform" -%% click B href "https://github.com/stdlib-js/random-array-uniform/tree/main" -%% click C href "https://github.com/stdlib-js/random-array-uniform/tree/production" -%% click D href "https://github.com/stdlib-js/random-array-uniform/tree/esm" -%% click E href "https://github.com/stdlib-js/random-array-uniform/tree/deno" -%% click F href "https://github.com/stdlib-js/random-array-uniform/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/uniform -[production-url]: https://github.com/stdlib-js/random-array-uniform/tree/production -[deno-url]: https://github.com/stdlib-js/random-array-uniform/tree/deno -[umd-url]: https://github.com/stdlib-js/random-array-uniform/tree/umd -[esm-url]: https://github.com/stdlib-js/random-array-uniform/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 f2a679f..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import uniform from '../docs/types/index'; -export = uniform; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 0ef1443..0000000 --- a/dist/index.js +++ /dev/null @@ -1,9 +0,0 @@ -"use strict";var y=function(t,r){return function(){return r||t((r={exports:{}}).exports,r),r.exports}};var b=y(function(ue,H){H.exports={dtype:"float64"}});var O=y(function(se,G){ -var J=require('@stdlib/array-typed-real-float-dtypes/dist'),K=require('@stdlib/assert-is-plain-object/dist'),M=require('@stdlib/assert-has-own-property/dist'),N=require('@stdlib/error-tools-fmtprodmsg/dist'),w=J();w.push("generic");function Q(t,r){return K(r)?M(r,"dtype")&&(t.dtype=r.dtype,w.indexOf(t.dtype)<0)?new TypeError(N('1eR4S',"dtype",w.join('", "'),t.dtype)):null:new TypeError(N('1eR2V',r));}G.exports=Q -});var R=y(function(oe,F){ -var S=require('@stdlib/assert-is-nonnegative-integer/dist').isPrimitive,d=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),l=require('@stdlib/utils-define-nonenumerable-read-only-accessor/dist'),x=require('@stdlib/utils-define-nonenumerable-read-write-accessor/dist'),U=require('@stdlib/utils-constant-function/dist'),X=require('@stdlib/utils-noop/dist'),p=require('@stdlib/random-base-uniform/dist'),E=require('@stdlib/array-typed-real-float-ctors/dist'),T=require('@stdlib/array-base-filled-by/dist'),Z=require('@stdlib/strided-base-nullary/dist'),_=require('@stdlib/strided-base-binary/dist'),j=require('@stdlib/error-tools-fmtprodmsg/dist'),$=b(),m=O();function ee(){var t,r,v,e,a,s;if(v={dtype:$.dtype},r=arguments.length,r===0)a=p,e=P;else if(r===1){if(t=arguments[0],a=p.factory(t),s=m(v,t),s)throw s;e=P}else if(r===2)a=p.factory(arguments[0],arguments[1]),e=L;else if(r===3){if(t=arguments[2],a=p.factory(arguments[0],arguments[1],t),s=m(v,t),s)throw s;e=L}return t&&t.prng?(d(e,"seed",null),d(e,"seedLength",null),x(e,"state",U(null),X),d(e,"stateLength",null),d(e,"byteLength",null)):(l(e,"seed",B),l(e,"seedLength",D),x(e,"state",Y,k),l(e,"stateLength",I),l(e,"byteLength",W)),d(e,"PRNG",a.PRNG),e;function L(n,c){var f,g,o,i,u;if(!S(n))throw new TypeError(j('1eR2d',n));if(u={},arguments.length>1&&(o=m(u,c),o))throw o;return i=u.dtype||v.dtype,i==="generic"?T(n,a):(f=E(i),g=new f(n),Z([g],[n],[1],a),g)}function P(n,c,f,g){var o,i,u,h,q;if(!S(n))throw new TypeError(j('1eR2d',n));if(q={},arguments.length>3&&(u=m(q,g),u))throw u;if(h=q.dtype||v.dtype,h==="generic")return T(n,C);return o=E(h),i=new o(n),_([[c],[f],i],[n],[0,0,1],a),i;function C(){return a(c,f)}}function B(){return e.PRNG.seed}function D(){return e.PRNG.seedLength}function I(){return e.PRNG.stateLength}function W(){return e.PRNG.byteLength}function Y(){return e.PRNG.state}function k(n){e.PRNG.state=n}}F.exports=ee -});var A=y(function(ve,V){ -var re=R(),te=re();V.exports=te -});var ne=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),z=A(),ae=R();ne(z,"factory",ae);module.exports=z; -/** @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 fcb8851..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/defaults.json", "../lib/validate.js", "../lib/factory.js", "../lib/main.js", "../lib/index.js"], - "sourcesContent": ["{\n\t\"dtype\": \"float64\"\n}\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 dtypes = require( '@stdlib/array-typed-real-float-dtypes' );\nvar isObject = require( '@stdlib/assert-is-plain-object' );\nvar hasOwnProp = require( '@stdlib/assert-has-own-property' );\nvar format = require( '@stdlib/string-format' );\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes();\nDTYPES.push( 'generic' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( DTYPES.indexOf( opts.dtype ) < 0 ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be one of the following: \"%s\". Option: `%s`.', 'dtype', DTYPES.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nmodule.exports = validate;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive;\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar setReadOnlyAccessor = require( '@stdlib/utils-define-nonenumerable-read-only-accessor' );\nvar setReadWriteAccessor = require( '@stdlib/utils-define-nonenumerable-read-write-accessor' );\nvar constantFunction = require( '@stdlib/utils-constant-function' );\nvar noop = require( '@stdlib/utils-noop' );\nvar base = require( '@stdlib/random-base-uniform' );\nvar ctors = require( '@stdlib/array-typed-real-float-ctors' );\nvar filledBy = require( '@stdlib/array-base-filled-by' );\nvar nullary = require( '@stdlib/strided-base-nullary' );\nvar binary = require( '@stdlib/strided-base-binary' );\nvar format = require( '@stdlib/string-format' );\nvar defaults = require( './defaults.json' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution.\n*\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\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 {RangeError} `a` must be less than `b`\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 uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10 );\n* // returns \n*\n* @example\n* var uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nfunction factory() {\n\tvar options;\n\tvar nargs;\n\tvar opts;\n\tvar rand;\n\tvar prng;\n\tvar err;\n\n\topts = {\n\t\t'dtype': defaults.dtype\n\t};\n\n\tnargs = arguments.length;\n\tif ( nargs === 0 ) {\n\t\tprng = base;\n\t\trand = uniform2;\n\t} else if ( nargs === 1 ) {\n\t\toptions = arguments[ 0 ];\n\t\tprng = base.factory( options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform2;\n\t} else if ( nargs === 2 ) {\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ] );\n\t\trand = uniform1;\n\t} else if ( nargs === 3 ) {\n\t\toptions = arguments[ 2 ];\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ], options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform1;\n\t}\n\tif ( options && options.prng ) {\n\t\tsetReadOnly( rand, 'seed', null );\n\t\tsetReadOnly( rand, 'seedLength', null );\n\t\tsetReadWriteAccessor( rand, 'state', constantFunction( null ), noop );\n\t\tsetReadOnly( rand, 'stateLength', null );\n\t\tsetReadOnly( rand, 'byteLength', null );\n\t} else {\n\t\tsetReadOnlyAccessor( rand, 'seed', getSeed );\n\t\tsetReadOnlyAccessor( rand, 'seedLength', getSeedLength );\n\t\tsetReadWriteAccessor( rand, 'state', getState, setState );\n\t\tsetReadOnlyAccessor( rand, 'stateLength', getStateLength );\n\t\tsetReadOnlyAccessor( rand, 'byteLength', getStateSize );\n\t}\n\tsetReadOnly( rand, 'PRNG', prng.PRNG );\n\treturn rand;\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform1( len, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 1 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, prng );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tnullary( [ out ], [ len ], [ 1 ], prng );\n\t\treturn out;\n\t}\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {number} a - minimum support\n\t* @param {number} b - maximum support\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform2( len, a, b, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 3 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\t// NOTE: we could alternatively use the PRNG factory function to create a PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. Decision made here to avoid this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom number. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in a return value of `NaN`.\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, wrapper );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tbinary( [ [ a ], [ b ], out ], [ len ], [ 0, 0, 1 ], prng );\n\t\treturn out;\n\n\t\t/**\n\t\t* Applies parameters to a pseudorandom number generator function.\n\t\t*\n\t\t* @private\n\t\t* @returns {number} pseudorandom number\n\t\t*/\n\t\tfunction wrapper() {\n\t\t\treturn prng( a, b );\n\t\t}\n\t}\n\n\t/**\n\t* Returns the PRNG seed.\n\t*\n\t* @private\n\t* @returns {PRNGSeedMT19937} seed\n\t*/\n\tfunction getSeed() {\n\t\treturn rand.PRNG.seed;\n\t}\n\n\t/**\n\t* Returns the PRNG seed length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} seed length\n\t*/\n\tfunction getSeedLength() {\n\t\treturn rand.PRNG.seedLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state length\n\t*/\n\tfunction getStateLength() {\n\t\treturn rand.PRNG.stateLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state size (in bytes).\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state size (in bytes)\n\t*/\n\tfunction getStateSize() {\n\t\treturn rand.PRNG.byteLength;\n\t}\n\n\t/**\n\t* Returns the current pseudorandom number generator state.\n\t*\n\t* @private\n\t* @returns {PRNGStateMT19937} current state\n\t*/\n\tfunction getState() {\n\t\treturn rand.PRNG.state;\n\t}\n\n\t/**\n\t* Sets the pseudorandom number generator state.\n\t*\n\t* @private\n\t* @param {PRNGStateMT19937} s - generator state\n\t* @throws {Error} must provide a valid state\n\t*/\n\tfunction setState( s ) {\n\t\trand.PRNG.state = s;\n\t}\n}\n\n\n// EXPORTS //\n\nmodule.exports = factory;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @name uniform\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\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 = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar uniform = factory();\n\n\n// EXPORTS //\n\nmodule.exports = uniform;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @module @stdlib/random-array-uniform\n*\n* @example\n* var uniform = require( '@stdlib/random-array-uniform' );\n*\n* var arr = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var uniform = require( '@stdlib/random-array-uniform' );\n*\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* var uniform = require( '@stdlib/random-array-uniform' );\n*\n* var rand = uniform.factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* var uniform = require( '@stdlib/random-array-uniform' );\n*\n* var rand = uniform.factory( 2.0, 5.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\" }\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,GAAAC,EAAA,CAAAA,EAAA,SACC,MAAS,SACV,ICFA,IAAAC,EAAAC,EAAA,SAAAC,GAAAC,EAAA,cAsBA,IAAIC,EAAS,QAAS,uCAAwC,EAC1DC,EAAW,QAAS,gCAAiC,EACrDC,EAAa,QAAS,iCAAkC,EACxDC,EAAS,QAAS,uBAAwB,EAK1CC,EAASJ,EAAO,EACpBI,EAAO,KAAM,SAAU,EAwBvB,SAASC,EAAUC,EAAMC,EAAU,CAClC,OAAMN,EAAUM,CAAQ,EAGnBL,EAAYK,EAAS,OAAQ,IACjCD,EAAK,MAAQC,EAAQ,MAChBH,EAAO,QAASE,EAAK,KAAM,EAAI,GAC5B,IAAI,UAAWH,EAAQ,gFAAiF,QAASC,EAAO,KAAM,MAAO,EAAGE,EAAK,KAAM,CAAE,EAGvJ,KARC,IAAI,UAAWH,EAAQ,qEAAsEI,CAAQ,CAAE,CAShH,CAKAR,EAAO,QAAUM,ICvEjB,IAAAG,EAAAC,EAAA,SAAAC,GAAAC,EAAA,cAsBA,IAAIC,EAAuB,QAAS,uCAAwC,EAAE,YAC1EC,EAAc,QAAS,uDAAwD,EAC/EC,EAAsB,QAAS,uDAAwD,EACvFC,EAAuB,QAAS,wDAAyD,EACzFC,EAAmB,QAAS,iCAAkC,EAC9DC,EAAO,QAAS,oBAAqB,EACrCC,EAAO,QAAS,6BAA8B,EAC9CC,EAAQ,QAAS,sCAAuC,EACxDC,EAAW,QAAS,8BAA+B,EACnDC,EAAU,QAAS,8BAA+B,EAClDC,EAAS,QAAS,6BAA8B,EAChDC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IACXC,EAAW,IAwCf,SAASC,IAAU,CAClB,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EAOJ,GALAH,EAAO,CACN,MAASL,EAAS,KACnB,EAEAI,EAAQ,UAAU,OACbA,IAAU,EACdG,EAAOb,EACPY,EAAOG,UACIL,IAAU,EAAI,CAIzB,GAHAD,EAAU,UAAW,CAAE,EACvBI,EAAOb,EAAK,QAASS,CAAQ,EAC7BK,EAAMP,EAAUI,EAAMF,CAAQ,EACzBK,EACJ,MAAMA,EAEPF,EAAOG,CACR,SAAYL,IAAU,EACrBG,EAAOb,EAAK,QAAS,UAAW,CAAE,EAAG,UAAW,CAAE,CAAE,EACpDY,EAAOI,UACIN,IAAU,EAAI,CAIzB,GAHAD,EAAU,UAAW,CAAE,EACvBI,EAAOb,EAAK,QAAS,UAAW,CAAE,EAAG,UAAW,CAAE,EAAGS,CAAQ,EAC7DK,EAAMP,EAAUI,EAAMF,CAAQ,EACzBK,EACJ,MAAMA,EAEPF,EAAOI,CACR,CACA,OAAKP,GAAWA,EAAQ,MACvBd,EAAaiB,EAAM,OAAQ,IAAK,EAChCjB,EAAaiB,EAAM,aAAc,IAAK,EACtCf,EAAsBe,EAAM,QAASd,EAAkB,IAAK,EAAGC,CAAK,EACpEJ,EAAaiB,EAAM,cAAe,IAAK,EACvCjB,EAAaiB,EAAM,aAAc,IAAK,IAEtChB,EAAqBgB,EAAM,OAAQK,CAAQ,EAC3CrB,EAAqBgB,EAAM,aAAcM,CAAc,EACvDrB,EAAsBe,EAAM,QAASO,EAAUC,CAAS,EACxDxB,EAAqBgB,EAAM,cAAeS,CAAe,EACzDzB,EAAqBgB,EAAM,aAAcU,CAAa,GAEvD3B,EAAaiB,EAAM,OAAQC,EAAK,IAAK,EAC9BD,EAcP,SAASI,EAAUO,EAAKd,EAAU,CACjC,IAAIe,EACAC,EACAX,EACAY,EACAC,EACJ,GAAK,CAACjC,EAAsB6B,CAAI,EAC/B,MAAM,IAAI,UAAWlB,EAAQ,+EAAgFkB,CAAI,CAAE,EAGpH,GADAI,EAAI,CAAC,EACA,UAAU,OAAS,IACvBb,EAAMP,EAAUoB,EAAGlB,CAAQ,EACtBK,GACJ,MAAMA,EAIR,OADAY,EAAKC,EAAE,OAAShB,EAAK,MAChBe,IAAO,UACJxB,EAAUqB,EAAKV,CAAK,GAE5BW,EAAOvB,EAAOyB,CAAG,EACjBD,EAAM,IAAID,EAAMD,CAAI,EACpBpB,EAAS,CAAEsB,CAAI,EAAG,CAAEF,CAAI,EAAG,CAAE,CAAE,EAAGV,CAAK,EAChCY,EACR,CAgBA,SAASV,EAAUQ,EAAKK,EAAGC,EAAGpB,EAAU,CACvC,IAAIe,EACAC,EACAX,EACAY,EACAC,EACJ,GAAK,CAACjC,EAAsB6B,CAAI,EAC/B,MAAM,IAAI,UAAWlB,EAAQ,+EAAgFkB,CAAI,CAAE,EAGpH,GADAI,EAAI,CAAC,EACA,UAAU,OAAS,IACvBb,EAAMP,EAAUoB,EAAGlB,CAAQ,EACtBK,GACJ,MAAMA,EAKR,GADAY,EAAKC,EAAE,OAAShB,EAAK,MAChBe,IAAO,UACX,OAAOxB,EAAUqB,EAAKO,CAAQ,EAE/B,OAAAN,EAAOvB,EAAOyB,CAAG,EACjBD,EAAM,IAAID,EAAMD,CAAI,EACpBnB,EAAQ,CAAE,CAAEwB,CAAE,EAAG,CAAEC,CAAE,EAAGJ,CAAI,EAAG,CAAEF,CAAI,EAAG,CAAE,EAAG,EAAG,CAAE,EAAGV,CAAK,EACnDY,EAQP,SAASK,GAAU,CAClB,OAAOjB,EAAMe,EAAGC,CAAE,CACnB,CACD,CAQA,SAASZ,GAAU,CAClB,OAAOL,EAAK,KAAK,IAClB,CAQA,SAASM,GAAgB,CACxB,OAAON,EAAK,KAAK,UAClB,CAQA,SAASS,GAAiB,CACzB,OAAOT,EAAK,KAAK,WAClB,CAQA,SAASU,GAAe,CACvB,OAAOV,EAAK,KAAK,UAClB,CAQA,SAASO,GAAW,CACnB,OAAOP,EAAK,KAAK,KAClB,CASA,SAASQ,EAAUW,EAAI,CACtBnB,EAAK,KAAK,MAAQmB,CACnB,CACD,CAKAtC,EAAO,QAAUe,KCzRjB,IAAAwB,EAAAC,EAAA,SAAAC,GAAAC,EAAA,cAsBA,IAAIC,GAAU,IA8BVC,GAAUD,GAAQ,EAKtBD,EAAO,QAAUE,KCKjB,IAAIC,GAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,GAAU,IAKdF,GAAaC,EAAM,UAAWC,EAAQ,EAKtC,OAAO,QAAUD", - "names": ["require_defaults", "__commonJSMin", "exports", "module", "require_validate", "__commonJSMin", "exports", "module", "dtypes", "isObject", "hasOwnProp", "format", "DTYPES", "validate", "opts", "options", "require_factory", "__commonJSMin", "exports", "module", "isNonNegativeInteger", "setReadOnly", "setReadOnlyAccessor", "setReadWriteAccessor", "constantFunction", "noop", "base", "ctors", "filledBy", "nullary", "binary", "format", "defaults", "validate", "factory", "options", "nargs", "opts", "rand", "prng", "err", "uniform2", "uniform1", "getSeed", "getSeedLength", "getState", "setState", "getStateLength", "getStateSize", "len", "ctor", "out", "dt", "o", "a", "b", "wrapper", "s", "require_main", "__commonJSMin", "exports", "module", "factory", "uniform", "setReadOnly", "main", "factory"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 256216a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,169 +0,0 @@ - -{{alias}}( len, a, b[, options] ) - Returns an array containing pseudorandom numbers drawn from a continuous - uniform distribution. - - Parameters - ---------- - len: integer - Output array length. - - a: number - Minimum support. - - b: number - Maximum support. - - 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 ) - - - -{{alias}}.factory( [a, b, ][options] ) - Returns a function for creating arrays containing pseudorandom numbers drawn - from a continuous uniform distribution. - - If provided `a` and `b`, the returned function returns random variates drawn - from the specified distribution. - - If not provided `a` and `b`, the returned function requires that both `a` - and `b` 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. - - 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 ) - - - // Provide distribution parameters: - > fcn = {{alias}}.factory( 2.0, 5.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 ) - - - // Get a copy of the current state: - > var state = {{alias}}.state - - - > out = {{alias}}( 3, 2.0, 5.0 ) - - > out = {{alias}}( 3, 2.0, 5.0 ) - - - // Set the state: - > {{alias}}.state = state; - - // Regenerate a previous array: - > out = {{alias}}( 3, 2.0, 5.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 a087b98..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,355 +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. -*/ - -import random = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - random( 10, 2, 3 ); // $ExpectType RandomArray - random( 10, 1, 2 ); // $ExpectType RandomArray - random( 10, 1, 2, {} ); // $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 ); // $ExpectError - random( true, 2.0, 5.0 ); // $ExpectError - random( false, 2.0, 5.0 ); // $ExpectError - random( null, 2.0, 5.0 ); // $ExpectError - random( [], 2.0, 5.0 ); // $ExpectError - random( {}, 2.0, 5.0 ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - random( '5', 2.0, 5.0, {} ); // $ExpectError - random( true, 2.0, 5.0, {} ); // $ExpectError - random( false, 2.0, 5.0, {} ); // $ExpectError - random( null, 2.0, 5.0, {} ); // $ExpectError - random( [], 2.0, 5.0, {} ); // $ExpectError - random( {}, 2.0, 5.0, {} ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.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 ); // $ExpectError - random( 10, true, 5.0 ); // $ExpectError - random( 10, false, 5.0 ); // $ExpectError - random( 10, null, 5.0 ); // $ExpectError - random( 10, [], 5.0 ); // $ExpectError - random( 10, {}, 5.0 ); // $ExpectError - random( 10, ( x: number ): number => x, 5.0 ); // $ExpectError - - random( 10, '5', 5.0, {} ); // $ExpectError - random( 10, true, 5.0, {} ); // $ExpectError - random( 10, false, 5.0, {} ); // $ExpectError - random( 10, null, 5.0, {} ); // $ExpectError - random( 10, [], 5.0, {} ); // $ExpectError - random( 10, {}, 5.0, {} ); // $ExpectError - random( 10, ( x: number ): number => x, 5.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' ); // $ExpectError - random( 10, 2.0, true ); // $ExpectError - random( 10, 2.0, false ); // $ExpectError - random( 10, 2.0, null ); // $ExpectError - random( 10, 2.0, [] ); // $ExpectError - random( 10, 2.0, {} ); // $ExpectError - random( 10, 2.0, ( x: number ): number => x ); // $ExpectError - - random( 10, 2.0, '5', {} ); // $ExpectError - random( 10, 2.0, true, {} ); // $ExpectError - random( 10, 2.0, false, {} ); // $ExpectError - random( 10, 2.0, null, {} ); // $ExpectError - random( 10, 2.0, [], {} ); // $ExpectError - random( 10, 2.0, {}, {} ); // $ExpectError - random( 10, 2.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, '5' ); // $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, [] ); // $ExpectError - random( 10, 2.0, 5.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, { 'dtype': 123 } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': null } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - random( 10, 2.0, 5.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 -} - -// Attached to main export is a `factory` method which returns a function... -{ - random.factory( 2.0, 5.0 ); // $ExpectType UnaryFunction - random.factory( 2.0, 5.0, { 'copy': false } ); // $ExpectType UnaryFunction - - random.factory(); // $ExpectType TernaryFunction - random.factory( { 'copy': false } ); // $ExpectType TernaryFunction -} - -// The `factory` method returns a function which returns an array... -{ - const fcn1 = random.factory( 2.0, 5.0 ); - fcn1( 10 ); // $ExpectType RandomArray - - const fcn2 = random.factory(); - fcn2( 10, 2.0, 5.0 ); // $ExpectType RandomArray -} - -// The compiler throws an error if the `factory` method is provided invalid arguments... -{ - random.factory( '5', 5.0 ); // $ExpectError - random.factory( true, 5.0 ); // $ExpectError - random.factory( false, 5.0 ); // $ExpectError - random.factory( [], 5.0 ); // $ExpectError - random.factory( {}, 5.0 ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0 ); // $ExpectError - - random.factory( '5', 5.0, {} ); // $ExpectError - random.factory( true, 5.0, {} ); // $ExpectError - random.factory( false, 5.0, {} ); // $ExpectError - random.factory( [], 5.0, {} ); // $ExpectError - random.factory( {}, 5.0, {} ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0, {} ); // $ExpectError - - random.factory( 2.0, '5' ); // $ExpectError - random.factory( 2.0, true ); // $ExpectError - random.factory( 2.0, false ); // $ExpectError - random.factory( 2.0, [] ); // $ExpectError - random.factory( 2.0, {} ); // $ExpectError - random.factory( 2.0, ( x: number ): number => x ); // $ExpectError - - random.factory( 2.0, '5', {} ); // $ExpectError - random.factory( 2.0, true, {} ); // $ExpectError - random.factory( 2.0, false, {} ); // $ExpectError - random.factory( 2.0, [], {} ); // $ExpectError - random.factory( 2.0, {}, {} ); // $ExpectError - random.factory( 2.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, 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, { 'prng': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'seed': true } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': [ 'a' ] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'state': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': {} } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': true ); // $ExpectError - random.factory( 2.0, 5.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, { 'copy': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'dtype': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - random.factory( 2.0, 5.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, {}, {} ); // $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 ); - 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 ); // $ExpectError - fcn2( false, 2.0, 5.0 ); // $ExpectError - fcn2( '5', 2.0, 5.0 ); // $ExpectError - fcn2( [], 2.0, 5.0 ); // $ExpectError - fcn2( {}, 2.0, 5.0 ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - fcn2( true, 2.0, 5.0, {} ); // $ExpectError - fcn2( false, 2.0, 5.0, {} ); // $ExpectError - fcn2( '5', 2.0, 5.0, {} ); // $ExpectError - fcn2( [], 2.0, 5.0, {} ); // $ExpectError - fcn2( {}, 2.0, 5.0, {} ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0, {} ); // $ExpectError - - fcn2( 10, true, 5.0 ); // $ExpectError - fcn2( 10, false, 5.0 ); // $ExpectError - fcn2( 10, '5', 5.0 ); // $ExpectError - fcn2( 10, [], 5.0 ); // $ExpectError - fcn2( 10, {}, 5.0 ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0 ); // $ExpectError - - fcn2( 10, true, 5.0, {} ); // $ExpectError - fcn2( 10, false, 5.0, {} ); // $ExpectError - fcn2( 10, '5', 5.0, {} ); // $ExpectError - fcn2( 10, [], 5.0, {} ); // $ExpectError - fcn2( 10, {}, 5.0, {} ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0, {} ); // $ExpectError - - fcn2( 10, 2.0, true ); // $ExpectError - fcn2( 10, 2.0, false ); // $ExpectError - fcn2( 10, 2.0, '5' ); // $ExpectError - fcn2( 10, 2.0, [] ); // $ExpectError - fcn2( 10, 2.0, {} ); // $ExpectError - fcn2( 10, 2.0, ( x: number ): number => x ); // $ExpectError - - fcn2( 10, 2.0, true, {} ); // $ExpectError - fcn2( 10, 2.0, false, {} ); // $ExpectError - fcn2( 10, 2.0, '5', {} ); // $ExpectError - fcn2( 10, 2.0, [], {} ); // $ExpectError - fcn2( 10, 2.0, {}, {} ); // $ExpectError - fcn2( 10, 2.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, { 'dtype': 123 } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': null } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError - - const fcn2 = random.factory( 2.0, 5.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 ); - fcn1(); // $ExpectError - fcn1( 1, 1, 1 ); // $ExpectError - - const fcn2 = random.factory(); - fcn2(); // $ExpectError - fcn2( 1 ); // $ExpectError - fcn2( 1, 1, 1, 1 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index c485546..0000000 --- a/examples/index.js +++ /dev/null @@ -1,48 +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'; - -var logEach = require( '@stdlib/console-log-each' ); -var uniform = require( './../lib' ); - -// Create a function for generating random arrays originating from the same state: -var random = uniform.factory( 2.0, 5.0, { - 'state': uniform.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 = uniform.factory( 2.0, 5.0, { - 'state': uniform.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 807b033..8f3c81f 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { RealFloatingPointDataType, 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..653f3c5 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.1.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-accessor@v0.1.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-write-accessor@v0.1.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-constant-function@v0.1.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-noop@v0.1.1-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/random-base-uniform@v0.1.0-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-typed-real-float-ctors@v0.1.0-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@v0.1.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-nullary@v0.1.0-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@v0.1.0-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/string-format@v0.1.1-esm/index.mjs";import f from"https://cdn.jsdelivr.net/gh/stdlib-js/array-typed-real-float-dtypes@v0.1.1-esm/index.mjs";import u from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.1.0-esm/index.mjs";import h from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.1.1-esm/index.mjs";var j="float64",g=f();function c(e,t){return u(t)?h(t,"dtype")&&(e.dtype=t.dtype,g.indexOf(e.dtype)<0)?new TypeError(p('invalid option. `%s` option must be one of the following: "%s". Option: `%s`.',"dtype",g.join('", "'),e.dtype)):null:new TypeError(p("invalid argument. Options argument must be an object. Value: `%s`.",t))}function v(){var f,u,h,g,v,y;if(h={dtype:j},0===(u=arguments.length))v=d,g=x;else if(1===u){if(f=arguments[0],v=d.factory(f),y=c(h,f))throw y;g=x}else if(2===u)v=d.factory(arguments[0],arguments[1]),g=b;else if(3===u){if(f=arguments[2],v=d.factory(arguments[0],arguments[1],f),y=c(h,f))throw y;g=b}return f&&f.prng?(e(g,"seed",null),e(g,"seedLength",null),s(g,"state",r(null),i),e(g,"stateLength",null),e(g,"byteLength",null)):(n(g,"seed",w),n(g,"seedLength",L),s(g,"state",P,R),n(g,"stateLength",G),n(g,"byteLength",N)),e(g,"PRNG",v.PRNG),g;function b(e,n){var s,r,i,d;if(!t(e))throw new TypeError(p("invalid argument. First argument must be a nonnegative integer. Value: `%s`.",e));if(d={},arguments.length>1&&(r=c(d,n)))throw r;return"generic"===(i=d.dtype||h.dtype)?l(e,v):(s=new(o(i))(e),m([s],[e],[1],v),s)}function x(e,n,s,r){var i,d,m,f;if(!t(e))throw new TypeError(p("invalid argument. First argument must be a nonnegative integer. Value: `%s`.",e));if(f={},arguments.length>3&&(d=c(f,r)))throw d;return"generic"===(m=f.dtype||h.dtype)?l(e,u):(i=new(o(m))(e),a([[n],[s],i],[e],[0,0,1],v),i);function u(){return v(n,s)}}function w(){return g.PRNG.seed}function L(){return g.PRNG.seedLength}function G(){return g.PRNG.stateLength}function N(){return g.PRNG.byteLength}function P(){return g.PRNG.state}function R(e){g.PRNG.state=e}}g.push("generic");var y=v();e(y,"factory",v);export{y as default,v as factory}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..b4fe4ef --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/factory.js","../lib/main.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 dtypes from '@stdlib/array-typed-real-float-dtypes';\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport format from '@stdlib/string-format';\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes();\nDTYPES.push( 'generic' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( DTYPES.indexOf( opts.dtype ) < 0 ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be one of the following: \"%s\". Option: `%s`.', 'dtype', DTYPES.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport setReadOnlyAccessor from '@stdlib/utils-define-nonenumerable-read-only-accessor';\nimport setReadWriteAccessor from '@stdlib/utils-define-nonenumerable-read-write-accessor';\nimport constantFunction from '@stdlib/utils-constant-function';\nimport noop from '@stdlib/utils-noop';\nimport base from '@stdlib/random-base-uniform';\nimport ctors from '@stdlib/array-typed-real-float-ctors';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport nullary from '@stdlib/strided-base-nullary';\nimport binary from '@stdlib/strided-base-binary';\nimport format from '@stdlib/string-format';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution.\n*\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\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 {RangeError} `a` must be less than `b`\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 uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10 );\n* // returns \n*\n* @example\n* var uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nfunction factory() {\n\tvar options;\n\tvar nargs;\n\tvar opts;\n\tvar rand;\n\tvar prng;\n\tvar err;\n\n\topts = {\n\t\t'dtype': defaults.dtype\n\t};\n\n\tnargs = arguments.length;\n\tif ( nargs === 0 ) {\n\t\tprng = base;\n\t\trand = uniform2;\n\t} else if ( nargs === 1 ) {\n\t\toptions = arguments[ 0 ];\n\t\tprng = base.factory( options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform2;\n\t} else if ( nargs === 2 ) {\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ] );\n\t\trand = uniform1;\n\t} else if ( nargs === 3 ) {\n\t\toptions = arguments[ 2 ];\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ], options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform1;\n\t}\n\tif ( options && options.prng ) {\n\t\tsetReadOnly( rand, 'seed', null );\n\t\tsetReadOnly( rand, 'seedLength', null );\n\t\tsetReadWriteAccessor( rand, 'state', constantFunction( null ), noop );\n\t\tsetReadOnly( rand, 'stateLength', null );\n\t\tsetReadOnly( rand, 'byteLength', null );\n\t} else {\n\t\tsetReadOnlyAccessor( rand, 'seed', getSeed );\n\t\tsetReadOnlyAccessor( rand, 'seedLength', getSeedLength );\n\t\tsetReadWriteAccessor( rand, 'state', getState, setState );\n\t\tsetReadOnlyAccessor( rand, 'stateLength', getStateLength );\n\t\tsetReadOnlyAccessor( rand, 'byteLength', getStateSize );\n\t}\n\tsetReadOnly( rand, 'PRNG', prng.PRNG );\n\treturn rand;\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform1( len, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 1 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, prng );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tnullary( [ out ], [ len ], [ 1 ], prng );\n\t\treturn out;\n\t}\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {number} a - minimum support\n\t* @param {number} b - maximum support\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform2( len, a, b, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 3 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\t// NOTE: we could alternatively use the PRNG factory function to create a PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. Decision made here to avoid this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom number. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in a return value of `NaN`.\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, wrapper );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tbinary( [ [ a ], [ b ], out ], [ len ], [ 0, 0, 1 ], prng );\n\t\treturn out;\n\n\t\t/**\n\t\t* Applies parameters to a pseudorandom number generator function.\n\t\t*\n\t\t* @private\n\t\t* @returns {number} pseudorandom number\n\t\t*/\n\t\tfunction wrapper() {\n\t\t\treturn prng( a, b );\n\t\t}\n\t}\n\n\t/**\n\t* Returns the PRNG seed.\n\t*\n\t* @private\n\t* @returns {PRNGSeedMT19937} seed\n\t*/\n\tfunction getSeed() {\n\t\treturn rand.PRNG.seed;\n\t}\n\n\t/**\n\t* Returns the PRNG seed length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} seed length\n\t*/\n\tfunction getSeedLength() {\n\t\treturn rand.PRNG.seedLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state length\n\t*/\n\tfunction getStateLength() {\n\t\treturn rand.PRNG.stateLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state size (in bytes).\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state size (in bytes)\n\t*/\n\tfunction getStateSize() {\n\t\treturn rand.PRNG.byteLength;\n\t}\n\n\t/**\n\t* Returns the current pseudorandom number generator state.\n\t*\n\t* @private\n\t* @returns {PRNGStateMT19937} current state\n\t*/\n\tfunction getState() {\n\t\treturn rand.PRNG.state;\n\t}\n\n\t/**\n\t* Sets the pseudorandom number generator state.\n\t*\n\t* @private\n\t* @param {PRNGStateMT19937} s - generator state\n\t* @throws {Error} must provide a valid state\n\t*/\n\tfunction setState( s ) {\n\t\trand.PRNG.state = s;\n\t}\n}\n\n\n// EXPORTS //\n\nexport default factory;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @name uniform\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\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 = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar uniform = factory();\n\n\n// EXPORTS //\n\nexport default uniform;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @module @stdlib/random-array-uniform\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.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\" }\n"],"names":["DTYPES","dtypes","validate","opts","options","isObject","hasOwnProp","dtype","indexOf","TypeError","format","join","factory","nargs","rand","prng","err","defaults","arguments","length","base","uniform2","uniform1","setReadOnly","setReadWriteAccessor","constantFunction","noop","setReadOnlyAccessor","getSeed","getSeedLength","getState","setState","getStateLength","getStateSize","PRNG","len","out","dt","o","isNonNegativeInteger","filledBy","ctors","nullary","a","b","wrapper","binary","seed","seedLength","stateLength","byteLength","state","s","push","uniform","main"],"mappings":";;2gDA8BIA,EAASC,IAyBb,SAASC,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,WACzBD,EAAKI,MAAQH,EAAQG,MAChBP,EAAOQ,QAASL,EAAKI,OAAU,GAC5B,IAAIE,UAAWC,EAAQ,gFAAiF,QAASV,EAAOW,KAAM,QAAUR,EAAKI,QAG/I,KARC,IAAIE,UAAWC,EAAQ,qEAAsEN,GAStG,CCSA,SAASQ,IACR,IAAIR,EACAS,EACAV,EACAW,EACAC,EACAC,EAOJ,GALAb,EAAO,CACNI,MAASU,GAIK,KADfJ,EAAQK,UAAUC,QAEjBJ,EAAOK,EACPN,EAAOO,OACD,GAAe,IAAVR,EAAc,CAIzB,GAHAT,EAAUc,UAAW,GACrBH,EAAOK,EAAKR,QAASR,GACrBY,EAAMd,EAAUC,EAAMC,GAErB,MAAMY,EAEPF,EAAOO,CACT,MAAQ,GAAe,IAAVR,EACXE,EAAOK,EAAKR,QAASM,UAAW,GAAKA,UAAW,IAChDJ,EAAOQ,OACD,GAAe,IAAVT,EAAc,CAIzB,GAHAT,EAAUc,UAAW,GACrBH,EAAOK,EAAKR,QAASM,UAAW,GAAKA,UAAW,GAAKd,GACrDY,EAAMd,EAAUC,EAAMC,GAErB,MAAMY,EAEPF,EAAOQ,CACP,CAeD,OAdKlB,GAAWA,EAAQW,MACvBQ,EAAaT,EAAM,OAAQ,MAC3BS,EAAaT,EAAM,aAAc,MACjCU,EAAsBV,EAAM,QAASW,EAAkB,MAAQC,GAC/DH,EAAaT,EAAM,cAAe,MAClCS,EAAaT,EAAM,aAAc,QAEjCa,EAAqBb,EAAM,OAAQc,GACnCD,EAAqBb,EAAM,aAAce,GACzCL,EAAsBV,EAAM,QAASgB,EAAUC,GAC/CJ,EAAqBb,EAAM,cAAekB,GAC1CL,EAAqBb,EAAM,aAAcmB,IAE1CV,EAAaT,EAAM,OAAQC,EAAKmB,MACzBpB,EAcP,SAASQ,EAAUa,EAAK/B,GACvB,IACIgC,EACApB,EACAqB,EACAC,EACJ,IAAMC,EAAsBJ,GAC3B,MAAM,IAAI1B,UAAWC,EAAQ,+EAAgFyB,IAG9G,GADAG,EAAI,CAAA,EACCpB,UAAUC,OAAS,IACvBH,EAAMd,EAAUoC,EAAGlC,IAElB,MAAMY,EAIR,MAAY,aADZqB,EAAKC,EAAE/B,OAASJ,EAAKI,OAEbiC,EAAUL,EAAKpB,IAGvBqB,EAAM,IADCK,EAAOJ,GACR,CAAUF,GAChBO,EAAS,CAAEN,GAAO,CAAED,GAAO,CAAE,GAAKpB,GAC3BqB,EACP,CAgBD,SAASf,EAAUc,EAAKQ,EAAGC,EAAGxC,GAC7B,IACIgC,EACApB,EACAqB,EACAC,EACJ,IAAMC,EAAsBJ,GAC3B,MAAM,IAAI1B,UAAWC,EAAQ,+EAAgFyB,IAG9G,GADAG,EAAI,CAAA,EACCpB,UAAUC,OAAS,IACvBH,EAAMd,EAAUoC,EAAGlC,IAElB,MAAMY,EAKR,MAAY,aADZqB,EAAKC,EAAE/B,OAASJ,EAAKI,OAEbiC,EAAUL,EAAKU,IAGvBT,EAAM,IADCK,EAAOJ,GACR,CAAUF,GAChBW,EAAQ,CAAE,CAAEH,GAAK,CAAEC,GAAKR,GAAO,CAAED,GAAO,CAAE,EAAG,EAAG,GAAKpB,GAC9CqB,GAQP,SAASS,IACR,OAAO9B,EAAM4B,EAAGC,EAChB,CACD,CAQD,SAAShB,IACR,OAAOd,EAAKoB,KAAKa,IACjB,CAQD,SAASlB,IACR,OAAOf,EAAKoB,KAAKc,UACjB,CAQD,SAAShB,IACR,OAAOlB,EAAKoB,KAAKe,WACjB,CAQD,SAAShB,IACR,OAAOnB,EAAKoB,KAAKgB,UACjB,CAQD,SAASpB,IACR,OAAOhB,EAAKoB,KAAKiB,KACjB,CASD,SAASpB,EAAUqB,GAClBtC,EAAKoB,KAAKiB,MAAQC,CAClB,CACF,CDrPApD,EAAOqD,KAAM,WEqBV,IAACC,EAAU1C,ICiBdW,EAAAgC,EAAA,UAAA3C"} \ No newline at end of file diff --git a/lib/defaults.json b/lib/defaults.json deleted file mode 100644 index 83f4438..0000000 --- a/lib/defaults.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "dtype": "float64" -} diff --git a/lib/factory.js b/lib/factory.js deleted file mode 100644 index 22ec236..0000000 --- a/lib/factory.js +++ /dev/null @@ -1,282 +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 isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var setReadOnlyAccessor = require( '@stdlib/utils-define-nonenumerable-read-only-accessor' ); -var setReadWriteAccessor = require( '@stdlib/utils-define-nonenumerable-read-write-accessor' ); -var constantFunction = require( '@stdlib/utils-constant-function' ); -var noop = require( '@stdlib/utils-noop' ); -var base = require( '@stdlib/random-base-uniform' ); -var ctors = require( '@stdlib/array-typed-real-float-ctors' ); -var filledBy = require( '@stdlib/array-base-filled-by' ); -var nullary = require( '@stdlib/strided-base-nullary' ); -var binary = require( '@stdlib/strided-base-binary' ); -var format = require( '@stdlib/string-format' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution. -* -* @param {number} [a] - minimum support -* @param {number} [b] - maximum support -* @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 {RangeError} `a` must be less than `b` -* @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 uniform = factory( 2.0, 5.0 ); -* // returns -* -* var arr = uniform( 10 ); -* // returns -* -* @example -* var uniform = factory( 2.0, 5.0 ); -* // returns -* -* var arr = uniform( 10, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -function factory() { - var options; - var nargs; - var opts; - var rand; - var prng; - var err; - - opts = { - 'dtype': defaults.dtype - }; - - nargs = arguments.length; - if ( nargs === 0 ) { - prng = base; - rand = uniform2; - } else if ( nargs === 1 ) { - options = arguments[ 0 ]; - prng = base.factory( options ); - err = validate( opts, options ); - if ( err ) { - throw err; - } - rand = uniform2; - } else if ( nargs === 2 ) { - prng = base.factory( arguments[ 0 ], arguments[ 1 ] ); - rand = uniform1; - } else if ( nargs === 3 ) { - options = arguments[ 2 ]; - prng = base.factory( arguments[ 0 ], arguments[ 1 ], options ); - err = validate( opts, options ); - if ( err ) { - throw err; - } - rand = uniform1; - } - if ( options && options.prng ) { - setReadOnly( rand, 'seed', null ); - setReadOnly( rand, 'seedLength', null ); - setReadWriteAccessor( rand, 'state', constantFunction( null ), noop ); - setReadOnly( rand, 'stateLength', null ); - setReadOnly( rand, 'byteLength', null ); - } else { - setReadOnlyAccessor( rand, 'seed', getSeed ); - setReadOnlyAccessor( rand, 'seedLength', getSeedLength ); - setReadWriteAccessor( rand, 'state', getState, setState ); - setReadOnlyAccessor( rand, 'stateLength', getStateLength ); - setReadOnlyAccessor( rand, 'byteLength', getStateSize ); - } - setReadOnly( rand, 'PRNG', prng.PRNG ); - return rand; - - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @private - * @param {NonNegativeInteger} len - array length - * @param {Options} [options] - function options - * @param {string} [options.dtype] - 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 - */ - function uniform1( len, options ) { - var ctor; - var out; - var err; - var dt; - var o; - if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) ); - } - o = {}; - if ( arguments.length > 1 ) { - err = validate( o, options ); - if ( err ) { - throw err; - } - } - dt = o.dtype || opts.dtype; - if ( dt === 'generic' ) { - return filledBy( len, prng ); - } - ctor = ctors( dt ); - out = new ctor( len ); - nullary( [ out ], [ len ], [ 1 ], prng ); - return out; - } - - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @private - * @param {NonNegativeInteger} len - array length - * @param {number} a - minimum support - * @param {number} b - maximum support - * @param {Options} [options] - function options - * @param {string} [options.dtype] - 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 - */ - function uniform2( len, a, b, options ) { - var ctor; - var out; - var err; - var dt; - var o; - if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) ); - } - o = {}; - if ( arguments.length > 3 ) { - err = validate( o, options ); - if ( err ) { - throw err; - } - } - // NOTE: we could alternatively use the PRNG factory function to create a PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. Decision made here to avoid this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom number. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in a return value of `NaN`. - dt = o.dtype || opts.dtype; - if ( dt === 'generic' ) { - return filledBy( len, wrapper ); - } - ctor = ctors( dt ); - out = new ctor( len ); - binary( [ [ a ], [ b ], out ], [ len ], [ 0, 0, 1 ], prng ); - return out; - - /** - * Applies parameters to a pseudorandom number generator function. - * - * @private - * @returns {number} pseudorandom number - */ - function wrapper() { - return prng( a, b ); - } - } - - /** - * Returns the PRNG seed. - * - * @private - * @returns {PRNGSeedMT19937} seed - */ - function getSeed() { - return rand.PRNG.seed; - } - - /** - * Returns the PRNG seed length. - * - * @private - * @returns {PositiveInteger} seed length - */ - function getSeedLength() { - return rand.PRNG.seedLength; - } - - /** - * Returns the PRNG state length. - * - * @private - * @returns {PositiveInteger} state length - */ - function getStateLength() { - return rand.PRNG.stateLength; - } - - /** - * Returns the PRNG state size (in bytes). - * - * @private - * @returns {PositiveInteger} state size (in bytes) - */ - function getStateSize() { - return rand.PRNG.byteLength; - } - - /** - * Returns the current pseudorandom number generator state. - * - * @private - * @returns {PRNGStateMT19937} current state - */ - function getState() { - return rand.PRNG.state; - } - - /** - * Sets the pseudorandom number generator state. - * - * @private - * @param {PRNGStateMT19937} s - generator state - * @throws {Error} must provide a valid state - */ - function setState( s ) { - rand.PRNG.state = s; - } -} - - -// EXPORTS // - -module.exports = factory; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 0077f00..0000000 --- a/lib/index.js +++ /dev/null @@ -1,77 +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'; - -/** -* Create an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. -* -* @module @stdlib/random-array-uniform -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var arr = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var arr = uniform( 10, 2.0, 5.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var rand = uniform.factory( 2.0, 5.0 ); -* // returns -* -* var arr = rand( 10 ); -* // returns -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var rand = uniform.factory( 2.0, 5.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" } diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index da0d9b1..0000000 --- a/lib/main.js +++ /dev/null @@ -1,58 +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 factory = require( './factory.js' ); - - -// MAIN // - -/** -* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. -* -* @name uniform -* @type {Function} -* @param {NonNegativeInteger} len - array length -* @param {number} a - minimum support -* @param {number} b - maximum support -* @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 = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var arr = uniform( 10, 2.0, 5.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -var uniform = factory(); - - -// EXPORTS // - -module.exports = uniform; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index 40b9723..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,72 +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 dtypes = require( '@stdlib/array-typed-real-float-dtypes' ); -var isObject = require( '@stdlib/assert-is-plain-object' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var format = require( '@stdlib/string-format' ); - - -// VARIABLES // - -var DTYPES = dtypes(); -DTYPES.push( 'generic' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Options} options - function options -* @param {string} [options.dtype] - output array data type -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var options = { -* 'dtype': 'float64' -* }; -* var err = validate( opts, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); - } - if ( hasOwnProp( options, 'dtype' ) ) { - opts.dtype = options.dtype; - if ( DTYPES.indexOf( opts.dtype ) < 0 ) { - return new TypeError( format( 'invalid option. `%s` option must be one of the following: "%s". Option: `%s`.', 'dtype', DTYPES.join( '", "' ), opts.dtype ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index 69877a6..767a213 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 continuous uniform 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,55 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-filled-by": "^0.1.0", - "@stdlib/array-typed-real-float-ctors": "^0.1.0", - "@stdlib/array-typed-real-float-dtypes": "^0.1.1", - "@stdlib/assert-has-own-property": "^0.1.1", - "@stdlib/assert-is-nonnegative-integer": "^0.1.0", - "@stdlib/assert-is-plain-object": "^0.1.1", - "@stdlib/random-base-uniform": "^0.1.0", - "@stdlib/strided-base-binary": "^0.1.0", - "@stdlib/strided-base-nullary": "^0.1.0", - "@stdlib/error-tools-fmtprodmsg": "^0.1.1", - "@stdlib/types": "^0.2.0", - "@stdlib/utils-constant-function": "^0.1.1", - "@stdlib/utils-define-nonenumerable-read-only-accessor": "^0.1.1", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1", - "@stdlib/utils-define-nonenumerable-read-write-accessor": "^0.1.1", - "@stdlib/utils-noop": "^0.1.1" - }, - "devDependencies": { - "@stdlib/array-float32": "^0.1.1", - "@stdlib/array-float64": "^0.1.1", - "@stdlib/array-uint32": "^0.1.1", - "@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", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..1504aff --- /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.factory.js b/test/test.factory.js deleted file mode 100644 index a869e75..0000000 --- a/test/test.factory.js +++ /dev/null @@ -1,1328 +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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -tape( 'the function throws an error if the second distribution parameter is less than the first distribution parameter', function test( t ) { - var values; - var i; - - values = [ - [ 0.0, 0.0 ], - [ -2.0, -4.0 ], - [ 2.0, 1.0 ] - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( arr ) { - return function badValue() { - factory( arr[0], arr[1] ); - }; - } -}); - -tape( 'the function throws an error if the second distribution parameter is less than the first distribution parameter (options)', function test( t ) { - var values; - var i; - - values = [ - [ 0.0, 0.0 ], - [ -2.0, -4.0 ], - [ 2.0, 1.0 ] - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( arr ) { - return function badValue() { - factory( arr[0], arr[1], {} ); - }; - } -}); - -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, 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, { - '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, { - '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, { - '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, { - '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, { - '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, { - '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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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 ); - - 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 ); - - 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, { - '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 ); - - 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 ); - 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( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory(); - actual = random( 10, 2.0, 5.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( typeof actual[ i ], 'number', '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 ); - - 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 ); - - 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 ); - - 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 that generates `NaN` values if the first distribution parameter is greater than or equal to the second distribution parameter', function test( t ) { - var random; - var values; - var actual; - var i; - var j; - - random = factory(); - values = [ - [ 2.0, 1.0 ], - [ -3.0, -4.0 ], - [ 0.0, 0.0 ] - ]; - - for ( i = 0; i < values.length; i++ ) { - actual = random( 10, values[ i ][ 0 ], values[ i ][ 1 ] ); - for ( j = 0; j < actual.length; j++ ) { - t.strictEqual( isnan( actual[ j ] ), true, 'returns expected value when provided '+values[ 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, { - '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 ); - - 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, { - '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( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'float64' - }); - actual = random( 10, 2.0, 5.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( typeof actual[ i ], 'number', '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, { - '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( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'float32' - }); - actual = random( 10, 2.0, 5.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( typeof actual[ i ], 'number', '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, { - '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 ); - - 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, { - '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, { - '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 ); - - // 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, { - '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 ); - - // 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, { - '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 ); - - 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, { - 'prng': randu.normalized - }); - - randu = minstd.factory({ - 'seed': seed - }); - random2 = factory( 2.0, 5.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 ); - arr2 = random2( 10, 2.0, 5.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 c4fb6d3..0000000 --- a/test/test.js +++ /dev/null @@ -1,69 +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 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 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 37b0080..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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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, 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, { - '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 ); - - 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( typeof actual[ i ], 'number', '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, { - '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( typeof actual[ i ], 'number', '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, { - '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( typeof actual[ i ], 'number', '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, { - '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 ); - } - // Capture the current state: - state = random.state; - - // Move to a future state... - arr = random( 10, 2.0, 5.0 ); - for ( i = 0; i < 100; i++ ) { - random( 2, 2.0, 5.0 ); - } - // Set the state: - random.state = state; - - // Replay previously generated values: - t.deepEqual( random( 10, 2.0, 5.0 ), arr, 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.validate.js b/test/test.validate.js deleted file mode 100644 index 9fbe15f..0000000 --- a/test/test.validate.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 validate = require( './../lib/validate.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof validate, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function returns an error if provided an options argument which is not an object', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - void 0, - null, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, values[ i ] ); - t.equal( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided a `dtype` option which is not a supported data type', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - -5, - NaN, - true, - false, - void 0, - null, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, { - 'dtype': values[ i ] - }); - t.equal( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns null if all options are valid', function test( t ) { - var options; - var opts; - var err; - - options = { - 'dtype': 'float64' - }; - opts = {}; - err = validate( opts, options ); - - t.equal( err, null, 'returns null' ); - t.deepEqual( opts, options, 'sets option values' ); - - t.end(); -}); - -tape( 'the function ignores unrecognized/unsupported options', function test( t ) { - var options; - var opts; - var err; - - options = { - 'beep': true, - 'boop': 'bop' - }; - opts = {}; - err = validate( opts, options ); - - t.equal( err, null, 'returns null' ); - t.deepEqual( opts, {}, 'does not set any option values' ); - t.end(); -}); From 3b7f3923d60bf9a4f00dc0e4d7cc534d484e6c70 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Jan 2024 09:11:16 +0000 Subject: [PATCH 49/82] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index d45b763..69877a6 100644 --- a/package.json +++ b/package.json @@ -46,7 +46,7 @@ "@stdlib/random-base-uniform": "^0.1.0", "@stdlib/strided-base-binary": "^0.1.0", "@stdlib/strided-base-nullary": "^0.1.0", - "@stdlib/string-format": "^0.1.1", + "@stdlib/error-tools-fmtprodmsg": "^0.1.1", "@stdlib/types": "^0.2.0", "@stdlib/utils-constant-function": "^0.1.1", "@stdlib/utils-define-nonenumerable-read-only-accessor": "^0.1.1", From 9f42eb9eefb440b74598ec449bb895c617477667 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Jan 2024 15:50:17 +0000 Subject: [PATCH 50/82] Remove files --- index.d.ts | 245 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6427 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 8f3c81f..0000000 --- a/index.d.ts +++ /dev/null @@ -1,245 +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. -*/ - -// TypeScript Version: 4.1 - -/// - -import { RealFloatingPointDataType, FloatTypedArray } from '@stdlib/types/array'; -import * as random from '@stdlib/types/random'; - -/** -* Supported data types. -*/ -type DataType = RealFloatingPointDataType | 'generic'; - -/** -* 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 continuous uniform distribution with pre-specified parameter values. -*/ -interface UnaryFunction extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @param len - array length - * @param options - function options - * @returns output array - */ - ( len: number, options?: Options ): RandomArray; -} - -/** -* Interface for generating pseudorandom numbers drawn from a continuous uniform distribution without pre-specified parameter values. -*/ -interface TernaryFunction extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @param len - array length - * @param a - minimum support - * @param b - maximum support - * @param options - function options - * @returns output array - */ - ( len: number, a: number, b: number, options?: Options ): RandomArray; -} - -/** -* Interface for generating pseudorandom numbers drawn from a uniform distribution. -*/ -interface Random extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @param len - array length - * @param a - minimum support - * @param b - maximum support - * @param options - function options - * @returns output array - * - * @example - * var out = uniform( 10, 2.0, 5.0 ); - * // returns - */ - ( len: number, a: number, b: number, options?: Options ): RandomArray; - - /** - * Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution. - * - * ## Notes - * - * - When provided `a` and `b`, the returned function returns random variates drawn from the specified distribution. - * - * @param a - minimum support - * @param b - maximum support - * @param options - function options - * @throws `a` must be less than `b` - * @throws must provide a valid state - * @returns function for creating arrays - * - * @example - * var random = uniform.factory( 2.0, 5.0 ); - * - * var out = random( 10 ); - * // returns - * - * @example - * var random = uniform.factory( 2.0, 5.0, { - * 'seed': 297 - * }); - * var out = random( 10 ); - * // returns - */ - factory( a: number, b: number, options?: FactoryOptions ): UnaryFunction; - - /** - * Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution. - * - * ## Notes - * - * - When not provided `a` and `b`, the returned function requires that both `a` and `b` be provided at each invocation. - * - * @param options - function options - * @throws must provide a valid state - * @returns function for creating arrays - * - * @example - * var random = uniform.factory(); - * - * var out = random( 10, 2.0, 5.0 ); - * // returns - * - * @example - * var random = uniform.factory({ - * 'seed': 297 - * }); - * var out = random( 10, 2.0, 5.0 ); - * // returns - */ - factory( options?: FactoryOptions ): TernaryFunction; -} - -/** -* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. -* -* @param len - array length -* @param a - minimum support -* @param b - maximum support -* @param options - function options -* @returns output array -* -* @example -* var out = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var random = uniform.factory( 2.0, 5.0 ); -* -* var out = random( 10 ); -* // returns -*/ -declare var uniform: Random; - - -// EXPORTS // - -export = uniform; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 653f3c5..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.1.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-accessor@v0.1.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-write-accessor@v0.1.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-constant-function@v0.1.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-noop@v0.1.1-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/random-base-uniform@v0.1.0-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-typed-real-float-ctors@v0.1.0-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@v0.1.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-nullary@v0.1.0-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@v0.1.0-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/string-format@v0.1.1-esm/index.mjs";import f from"https://cdn.jsdelivr.net/gh/stdlib-js/array-typed-real-float-dtypes@v0.1.1-esm/index.mjs";import u from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.1.0-esm/index.mjs";import h from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.1.1-esm/index.mjs";var j="float64",g=f();function c(e,t){return u(t)?h(t,"dtype")&&(e.dtype=t.dtype,g.indexOf(e.dtype)<0)?new TypeError(p('invalid option. `%s` option must be one of the following: "%s". Option: `%s`.',"dtype",g.join('", "'),e.dtype)):null:new TypeError(p("invalid argument. Options argument must be an object. Value: `%s`.",t))}function v(){var f,u,h,g,v,y;if(h={dtype:j},0===(u=arguments.length))v=d,g=x;else if(1===u){if(f=arguments[0],v=d.factory(f),y=c(h,f))throw y;g=x}else if(2===u)v=d.factory(arguments[0],arguments[1]),g=b;else if(3===u){if(f=arguments[2],v=d.factory(arguments[0],arguments[1],f),y=c(h,f))throw y;g=b}return f&&f.prng?(e(g,"seed",null),e(g,"seedLength",null),s(g,"state",r(null),i),e(g,"stateLength",null),e(g,"byteLength",null)):(n(g,"seed",w),n(g,"seedLength",L),s(g,"state",P,R),n(g,"stateLength",G),n(g,"byteLength",N)),e(g,"PRNG",v.PRNG),g;function b(e,n){var s,r,i,d;if(!t(e))throw new TypeError(p("invalid argument. First argument must be a nonnegative integer. Value: `%s`.",e));if(d={},arguments.length>1&&(r=c(d,n)))throw r;return"generic"===(i=d.dtype||h.dtype)?l(e,v):(s=new(o(i))(e),m([s],[e],[1],v),s)}function x(e,n,s,r){var i,d,m,f;if(!t(e))throw new TypeError(p("invalid argument. First argument must be a nonnegative integer. Value: `%s`.",e));if(f={},arguments.length>3&&(d=c(f,r)))throw d;return"generic"===(m=f.dtype||h.dtype)?l(e,u):(i=new(o(m))(e),a([[n],[s],i],[e],[0,0,1],v),i);function u(){return v(n,s)}}function w(){return g.PRNG.seed}function L(){return g.PRNG.seedLength}function G(){return g.PRNG.stateLength}function N(){return g.PRNG.byteLength}function P(){return g.PRNG.state}function R(e){g.PRNG.state=e}}g.push("generic");var y=v();e(y,"factory",v);export{y as default,v as factory}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index b4fe4ef..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/factory.js","../lib/main.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 dtypes from '@stdlib/array-typed-real-float-dtypes';\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport format from '@stdlib/string-format';\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes();\nDTYPES.push( 'generic' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( DTYPES.indexOf( opts.dtype ) < 0 ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be one of the following: \"%s\". Option: `%s`.', 'dtype', DTYPES.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport setReadOnlyAccessor from '@stdlib/utils-define-nonenumerable-read-only-accessor';\nimport setReadWriteAccessor from '@stdlib/utils-define-nonenumerable-read-write-accessor';\nimport constantFunction from '@stdlib/utils-constant-function';\nimport noop from '@stdlib/utils-noop';\nimport base from '@stdlib/random-base-uniform';\nimport ctors from '@stdlib/array-typed-real-float-ctors';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport nullary from '@stdlib/strided-base-nullary';\nimport binary from '@stdlib/strided-base-binary';\nimport format from '@stdlib/string-format';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution.\n*\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\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 {RangeError} `a` must be less than `b`\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 uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10 );\n* // returns \n*\n* @example\n* var uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nfunction factory() {\n\tvar options;\n\tvar nargs;\n\tvar opts;\n\tvar rand;\n\tvar prng;\n\tvar err;\n\n\topts = {\n\t\t'dtype': defaults.dtype\n\t};\n\n\tnargs = arguments.length;\n\tif ( nargs === 0 ) {\n\t\tprng = base;\n\t\trand = uniform2;\n\t} else if ( nargs === 1 ) {\n\t\toptions = arguments[ 0 ];\n\t\tprng = base.factory( options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform2;\n\t} else if ( nargs === 2 ) {\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ] );\n\t\trand = uniform1;\n\t} else if ( nargs === 3 ) {\n\t\toptions = arguments[ 2 ];\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ], options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform1;\n\t}\n\tif ( options && options.prng ) {\n\t\tsetReadOnly( rand, 'seed', null );\n\t\tsetReadOnly( rand, 'seedLength', null );\n\t\tsetReadWriteAccessor( rand, 'state', constantFunction( null ), noop );\n\t\tsetReadOnly( rand, 'stateLength', null );\n\t\tsetReadOnly( rand, 'byteLength', null );\n\t} else {\n\t\tsetReadOnlyAccessor( rand, 'seed', getSeed );\n\t\tsetReadOnlyAccessor( rand, 'seedLength', getSeedLength );\n\t\tsetReadWriteAccessor( rand, 'state', getState, setState );\n\t\tsetReadOnlyAccessor( rand, 'stateLength', getStateLength );\n\t\tsetReadOnlyAccessor( rand, 'byteLength', getStateSize );\n\t}\n\tsetReadOnly( rand, 'PRNG', prng.PRNG );\n\treturn rand;\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform1( len, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 1 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, prng );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tnullary( [ out ], [ len ], [ 1 ], prng );\n\t\treturn out;\n\t}\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {number} a - minimum support\n\t* @param {number} b - maximum support\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform2( len, a, b, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 3 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\t// NOTE: we could alternatively use the PRNG factory function to create a PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. Decision made here to avoid this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom number. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in a return value of `NaN`.\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, wrapper );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tbinary( [ [ a ], [ b ], out ], [ len ], [ 0, 0, 1 ], prng );\n\t\treturn out;\n\n\t\t/**\n\t\t* Applies parameters to a pseudorandom number generator function.\n\t\t*\n\t\t* @private\n\t\t* @returns {number} pseudorandom number\n\t\t*/\n\t\tfunction wrapper() {\n\t\t\treturn prng( a, b );\n\t\t}\n\t}\n\n\t/**\n\t* Returns the PRNG seed.\n\t*\n\t* @private\n\t* @returns {PRNGSeedMT19937} seed\n\t*/\n\tfunction getSeed() {\n\t\treturn rand.PRNG.seed;\n\t}\n\n\t/**\n\t* Returns the PRNG seed length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} seed length\n\t*/\n\tfunction getSeedLength() {\n\t\treturn rand.PRNG.seedLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state length\n\t*/\n\tfunction getStateLength() {\n\t\treturn rand.PRNG.stateLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state size (in bytes).\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state size (in bytes)\n\t*/\n\tfunction getStateSize() {\n\t\treturn rand.PRNG.byteLength;\n\t}\n\n\t/**\n\t* Returns the current pseudorandom number generator state.\n\t*\n\t* @private\n\t* @returns {PRNGStateMT19937} current state\n\t*/\n\tfunction getState() {\n\t\treturn rand.PRNG.state;\n\t}\n\n\t/**\n\t* Sets the pseudorandom number generator state.\n\t*\n\t* @private\n\t* @param {PRNGStateMT19937} s - generator state\n\t* @throws {Error} must provide a valid state\n\t*/\n\tfunction setState( s ) {\n\t\trand.PRNG.state = s;\n\t}\n}\n\n\n// EXPORTS //\n\nexport default factory;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @name uniform\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\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 = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar uniform = factory();\n\n\n// EXPORTS //\n\nexport default uniform;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @module @stdlib/random-array-uniform\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.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\" }\n"],"names":["DTYPES","dtypes","validate","opts","options","isObject","hasOwnProp","dtype","indexOf","TypeError","format","join","factory","nargs","rand","prng","err","defaults","arguments","length","base","uniform2","uniform1","setReadOnly","setReadWriteAccessor","constantFunction","noop","setReadOnlyAccessor","getSeed","getSeedLength","getState","setState","getStateLength","getStateSize","PRNG","len","out","dt","o","isNonNegativeInteger","filledBy","ctors","nullary","a","b","wrapper","binary","seed","seedLength","stateLength","byteLength","state","s","push","uniform","main"],"mappings":";;2gDA8BIA,EAASC,IAyBb,SAASC,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,WACzBD,EAAKI,MAAQH,EAAQG,MAChBP,EAAOQ,QAASL,EAAKI,OAAU,GAC5B,IAAIE,UAAWC,EAAQ,gFAAiF,QAASV,EAAOW,KAAM,QAAUR,EAAKI,QAG/I,KARC,IAAIE,UAAWC,EAAQ,qEAAsEN,GAStG,CCSA,SAASQ,IACR,IAAIR,EACAS,EACAV,EACAW,EACAC,EACAC,EAOJ,GALAb,EAAO,CACNI,MAASU,GAIK,KADfJ,EAAQK,UAAUC,QAEjBJ,EAAOK,EACPN,EAAOO,OACD,GAAe,IAAVR,EAAc,CAIzB,GAHAT,EAAUc,UAAW,GACrBH,EAAOK,EAAKR,QAASR,GACrBY,EAAMd,EAAUC,EAAMC,GAErB,MAAMY,EAEPF,EAAOO,CACT,MAAQ,GAAe,IAAVR,EACXE,EAAOK,EAAKR,QAASM,UAAW,GAAKA,UAAW,IAChDJ,EAAOQ,OACD,GAAe,IAAVT,EAAc,CAIzB,GAHAT,EAAUc,UAAW,GACrBH,EAAOK,EAAKR,QAASM,UAAW,GAAKA,UAAW,GAAKd,GACrDY,EAAMd,EAAUC,EAAMC,GAErB,MAAMY,EAEPF,EAAOQ,CACP,CAeD,OAdKlB,GAAWA,EAAQW,MACvBQ,EAAaT,EAAM,OAAQ,MAC3BS,EAAaT,EAAM,aAAc,MACjCU,EAAsBV,EAAM,QAASW,EAAkB,MAAQC,GAC/DH,EAAaT,EAAM,cAAe,MAClCS,EAAaT,EAAM,aAAc,QAEjCa,EAAqBb,EAAM,OAAQc,GACnCD,EAAqBb,EAAM,aAAce,GACzCL,EAAsBV,EAAM,QAASgB,EAAUC,GAC/CJ,EAAqBb,EAAM,cAAekB,GAC1CL,EAAqBb,EAAM,aAAcmB,IAE1CV,EAAaT,EAAM,OAAQC,EAAKmB,MACzBpB,EAcP,SAASQ,EAAUa,EAAK/B,GACvB,IACIgC,EACApB,EACAqB,EACAC,EACJ,IAAMC,EAAsBJ,GAC3B,MAAM,IAAI1B,UAAWC,EAAQ,+EAAgFyB,IAG9G,GADAG,EAAI,CAAA,EACCpB,UAAUC,OAAS,IACvBH,EAAMd,EAAUoC,EAAGlC,IAElB,MAAMY,EAIR,MAAY,aADZqB,EAAKC,EAAE/B,OAASJ,EAAKI,OAEbiC,EAAUL,EAAKpB,IAGvBqB,EAAM,IADCK,EAAOJ,GACR,CAAUF,GAChBO,EAAS,CAAEN,GAAO,CAAED,GAAO,CAAE,GAAKpB,GAC3BqB,EACP,CAgBD,SAASf,EAAUc,EAAKQ,EAAGC,EAAGxC,GAC7B,IACIgC,EACApB,EACAqB,EACAC,EACJ,IAAMC,EAAsBJ,GAC3B,MAAM,IAAI1B,UAAWC,EAAQ,+EAAgFyB,IAG9G,GADAG,EAAI,CAAA,EACCpB,UAAUC,OAAS,IACvBH,EAAMd,EAAUoC,EAAGlC,IAElB,MAAMY,EAKR,MAAY,aADZqB,EAAKC,EAAE/B,OAASJ,EAAKI,OAEbiC,EAAUL,EAAKU,IAGvBT,EAAM,IADCK,EAAOJ,GACR,CAAUF,GAChBW,EAAQ,CAAE,CAAEH,GAAK,CAAEC,GAAKR,GAAO,CAAED,GAAO,CAAE,EAAG,EAAG,GAAKpB,GAC9CqB,GAQP,SAASS,IACR,OAAO9B,EAAM4B,EAAGC,EAChB,CACD,CAQD,SAAShB,IACR,OAAOd,EAAKoB,KAAKa,IACjB,CAQD,SAASlB,IACR,OAAOf,EAAKoB,KAAKc,UACjB,CAQD,SAAShB,IACR,OAAOlB,EAAKoB,KAAKe,WACjB,CAQD,SAAShB,IACR,OAAOnB,EAAKoB,KAAKgB,UACjB,CAQD,SAASpB,IACR,OAAOhB,EAAKoB,KAAKiB,KACjB,CASD,SAASpB,EAAUqB,GAClBtC,EAAKoB,KAAKiB,MAAQC,CAClB,CACF,CDrPApD,EAAOqD,KAAM,WEqBV,IAACC,EAAU1C,ICiBdW,EAAAgC,EAAA,UAAA3C"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 1504aff..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From ed5d81a0239fe99cc395e9235adae558771b698f Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Jan 2024 15:50:47 +0000 Subject: [PATCH 51/82] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 --- .github/workflows/publish.yml | 255 - .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 128 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 228 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 65 +- SECURITY.md | 5 - benchmark/benchmark.float32.factory.js | 96 - benchmark/benchmark.float32.js | 98 - benchmark/benchmark.float64.factory.js | 96 - benchmark/benchmark.float64.js | 98 - benchmark/benchmark.generic.factory.js | 96 - benchmark/benchmark.generic.js | 98 - branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 9 - dist/index.js.map | 7 - docs/repl.txt | 169 - docs/types/test.ts | 355 -- examples/index.js | 48 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/defaults.json | 3 - lib/factory.js | 282 - lib/index.js | 77 - lib/main.js | 58 - lib/validate.js | 72 - package.json | 76 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.factory.js | 1328 ----- test/test.js | 69 - test/test.main.js | 244 - test/test.validate.js | 118 - 54 files changed, 6217 insertions(+), 6787 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.factory.js delete mode 100644 benchmark/benchmark.float32.js delete mode 100644 benchmark/benchmark.float64.factory.js delete mode 100644 benchmark/benchmark.float64.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/defaults.json delete mode 100644 lib/factory.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.factory.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js delete mode 100644 test/test.validate.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 984ddf0..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-01-01T05:56:43.000Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index c4ab52b..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/uniform) 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 5097056..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/uniform) 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 7f3bcd6..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: '33 9 * * 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 + + ```
@@ -383,7 +382,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]. @@ -443,19 +442,19 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/random-array-uniform/main/LICENSE -[@stdlib/random/base/uniform]: https://github.com/stdlib-js/random-base-uniform +[@stdlib/random/base/uniform]: https://github.com/stdlib-js/random-base-uniform/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 -[@stdlib/random/array/discrete-uniform]: https://github.com/stdlib-js/random-array-discrete-uniform +[@stdlib/random/array/discrete-uniform]: https://github.com/stdlib-js/random-array-discrete-uniform/tree/esm -[@stdlib/random/strided/uniform]: https://github.com/stdlib-js/random-strided-uniform +[@stdlib/random/strided/uniform]: https://github.com/stdlib-js/random-strided-uniform/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.factory.js b/benchmark/benchmark.float32.factory.js deleted file mode 100644 index 62e5ae4..0000000 --- a/benchmark/benchmark.float32.factory.js +++ /dev/null @@ -1,96 +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 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 uniform = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var fcn = uniform.factory( 2.0, 5.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 1c88093..0000000 --- a/benchmark/benchmark.float32.js +++ /dev/null @@ -1,98 +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 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 uniform = 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 = uniform( len, 2.0, 5.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.factory.js b/benchmark/benchmark.float64.factory.js deleted file mode 100644 index 8fe28ee..0000000 --- a/benchmark/benchmark.float64.factory.js +++ /dev/null @@ -1,96 +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 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 uniform = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var fcn = uniform.factory( 2.0, 5.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 65ac42a..0000000 --- a/benchmark/benchmark.float64.js +++ /dev/null @@ -1,98 +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 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 uniform = 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 = uniform( len, 2.0, 5.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.factory.js b/benchmark/benchmark.generic.factory.js deleted file mode 100644 index 3648754..0000000 --- a/benchmark/benchmark.generic.factory.js +++ /dev/null @@ -1,96 +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 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 uniform = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var fcn = uniform.factory( 2.0, 5.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 0582c3e..0000000 --- a/benchmark/benchmark.generic.js +++ /dev/null @@ -1,98 +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 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 uniform = 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 = uniform( len, 2.0, 5.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 30542fb..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/uniform" -%% click B href "https://github.com/stdlib-js/random-array-uniform/tree/main" -%% click C href "https://github.com/stdlib-js/random-array-uniform/tree/production" -%% click D href "https://github.com/stdlib-js/random-array-uniform/tree/esm" -%% click E href "https://github.com/stdlib-js/random-array-uniform/tree/deno" -%% click F href "https://github.com/stdlib-js/random-array-uniform/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/uniform -[production-url]: https://github.com/stdlib-js/random-array-uniform/tree/production -[deno-url]: https://github.com/stdlib-js/random-array-uniform/tree/deno -[umd-url]: https://github.com/stdlib-js/random-array-uniform/tree/umd -[esm-url]: https://github.com/stdlib-js/random-array-uniform/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 f2a679f..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import uniform from '../docs/types/index'; -export = uniform; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 0ef1443..0000000 --- a/dist/index.js +++ /dev/null @@ -1,9 +0,0 @@ -"use strict";var y=function(t,r){return function(){return r||t((r={exports:{}}).exports,r),r.exports}};var b=y(function(ue,H){H.exports={dtype:"float64"}});var O=y(function(se,G){ -var J=require('@stdlib/array-typed-real-float-dtypes/dist'),K=require('@stdlib/assert-is-plain-object/dist'),M=require('@stdlib/assert-has-own-property/dist'),N=require('@stdlib/error-tools-fmtprodmsg/dist'),w=J();w.push("generic");function Q(t,r){return K(r)?M(r,"dtype")&&(t.dtype=r.dtype,w.indexOf(t.dtype)<0)?new TypeError(N('1eR4S',"dtype",w.join('", "'),t.dtype)):null:new TypeError(N('1eR2V',r));}G.exports=Q -});var R=y(function(oe,F){ -var S=require('@stdlib/assert-is-nonnegative-integer/dist').isPrimitive,d=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),l=require('@stdlib/utils-define-nonenumerable-read-only-accessor/dist'),x=require('@stdlib/utils-define-nonenumerable-read-write-accessor/dist'),U=require('@stdlib/utils-constant-function/dist'),X=require('@stdlib/utils-noop/dist'),p=require('@stdlib/random-base-uniform/dist'),E=require('@stdlib/array-typed-real-float-ctors/dist'),T=require('@stdlib/array-base-filled-by/dist'),Z=require('@stdlib/strided-base-nullary/dist'),_=require('@stdlib/strided-base-binary/dist'),j=require('@stdlib/error-tools-fmtprodmsg/dist'),$=b(),m=O();function ee(){var t,r,v,e,a,s;if(v={dtype:$.dtype},r=arguments.length,r===0)a=p,e=P;else if(r===1){if(t=arguments[0],a=p.factory(t),s=m(v,t),s)throw s;e=P}else if(r===2)a=p.factory(arguments[0],arguments[1]),e=L;else if(r===3){if(t=arguments[2],a=p.factory(arguments[0],arguments[1],t),s=m(v,t),s)throw s;e=L}return t&&t.prng?(d(e,"seed",null),d(e,"seedLength",null),x(e,"state",U(null),X),d(e,"stateLength",null),d(e,"byteLength",null)):(l(e,"seed",B),l(e,"seedLength",D),x(e,"state",Y,k),l(e,"stateLength",I),l(e,"byteLength",W)),d(e,"PRNG",a.PRNG),e;function L(n,c){var f,g,o,i,u;if(!S(n))throw new TypeError(j('1eR2d',n));if(u={},arguments.length>1&&(o=m(u,c),o))throw o;return i=u.dtype||v.dtype,i==="generic"?T(n,a):(f=E(i),g=new f(n),Z([g],[n],[1],a),g)}function P(n,c,f,g){var o,i,u,h,q;if(!S(n))throw new TypeError(j('1eR2d',n));if(q={},arguments.length>3&&(u=m(q,g),u))throw u;if(h=q.dtype||v.dtype,h==="generic")return T(n,C);return o=E(h),i=new o(n),_([[c],[f],i],[n],[0,0,1],a),i;function C(){return a(c,f)}}function B(){return e.PRNG.seed}function D(){return e.PRNG.seedLength}function I(){return e.PRNG.stateLength}function W(){return e.PRNG.byteLength}function Y(){return e.PRNG.state}function k(n){e.PRNG.state=n}}F.exports=ee -});var A=y(function(ve,V){ -var re=R(),te=re();V.exports=te -});var ne=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),z=A(),ae=R();ne(z,"factory",ae);module.exports=z; -/** @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 fcb8851..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/defaults.json", "../lib/validate.js", "../lib/factory.js", "../lib/main.js", "../lib/index.js"], - "sourcesContent": ["{\n\t\"dtype\": \"float64\"\n}\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 dtypes = require( '@stdlib/array-typed-real-float-dtypes' );\nvar isObject = require( '@stdlib/assert-is-plain-object' );\nvar hasOwnProp = require( '@stdlib/assert-has-own-property' );\nvar format = require( '@stdlib/string-format' );\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes();\nDTYPES.push( 'generic' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( DTYPES.indexOf( opts.dtype ) < 0 ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be one of the following: \"%s\". Option: `%s`.', 'dtype', DTYPES.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nmodule.exports = validate;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive;\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar setReadOnlyAccessor = require( '@stdlib/utils-define-nonenumerable-read-only-accessor' );\nvar setReadWriteAccessor = require( '@stdlib/utils-define-nonenumerable-read-write-accessor' );\nvar constantFunction = require( '@stdlib/utils-constant-function' );\nvar noop = require( '@stdlib/utils-noop' );\nvar base = require( '@stdlib/random-base-uniform' );\nvar ctors = require( '@stdlib/array-typed-real-float-ctors' );\nvar filledBy = require( '@stdlib/array-base-filled-by' );\nvar nullary = require( '@stdlib/strided-base-nullary' );\nvar binary = require( '@stdlib/strided-base-binary' );\nvar format = require( '@stdlib/string-format' );\nvar defaults = require( './defaults.json' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution.\n*\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\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 {RangeError} `a` must be less than `b`\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 uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10 );\n* // returns \n*\n* @example\n* var uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nfunction factory() {\n\tvar options;\n\tvar nargs;\n\tvar opts;\n\tvar rand;\n\tvar prng;\n\tvar err;\n\n\topts = {\n\t\t'dtype': defaults.dtype\n\t};\n\n\tnargs = arguments.length;\n\tif ( nargs === 0 ) {\n\t\tprng = base;\n\t\trand = uniform2;\n\t} else if ( nargs === 1 ) {\n\t\toptions = arguments[ 0 ];\n\t\tprng = base.factory( options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform2;\n\t} else if ( nargs === 2 ) {\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ] );\n\t\trand = uniform1;\n\t} else if ( nargs === 3 ) {\n\t\toptions = arguments[ 2 ];\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ], options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform1;\n\t}\n\tif ( options && options.prng ) {\n\t\tsetReadOnly( rand, 'seed', null );\n\t\tsetReadOnly( rand, 'seedLength', null );\n\t\tsetReadWriteAccessor( rand, 'state', constantFunction( null ), noop );\n\t\tsetReadOnly( rand, 'stateLength', null );\n\t\tsetReadOnly( rand, 'byteLength', null );\n\t} else {\n\t\tsetReadOnlyAccessor( rand, 'seed', getSeed );\n\t\tsetReadOnlyAccessor( rand, 'seedLength', getSeedLength );\n\t\tsetReadWriteAccessor( rand, 'state', getState, setState );\n\t\tsetReadOnlyAccessor( rand, 'stateLength', getStateLength );\n\t\tsetReadOnlyAccessor( rand, 'byteLength', getStateSize );\n\t}\n\tsetReadOnly( rand, 'PRNG', prng.PRNG );\n\treturn rand;\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform1( len, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 1 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, prng );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tnullary( [ out ], [ len ], [ 1 ], prng );\n\t\treturn out;\n\t}\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {number} a - minimum support\n\t* @param {number} b - maximum support\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform2( len, a, b, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 3 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\t// NOTE: we could alternatively use the PRNG factory function to create a PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. Decision made here to avoid this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom number. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in a return value of `NaN`.\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, wrapper );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tbinary( [ [ a ], [ b ], out ], [ len ], [ 0, 0, 1 ], prng );\n\t\treturn out;\n\n\t\t/**\n\t\t* Applies parameters to a pseudorandom number generator function.\n\t\t*\n\t\t* @private\n\t\t* @returns {number} pseudorandom number\n\t\t*/\n\t\tfunction wrapper() {\n\t\t\treturn prng( a, b );\n\t\t}\n\t}\n\n\t/**\n\t* Returns the PRNG seed.\n\t*\n\t* @private\n\t* @returns {PRNGSeedMT19937} seed\n\t*/\n\tfunction getSeed() {\n\t\treturn rand.PRNG.seed;\n\t}\n\n\t/**\n\t* Returns the PRNG seed length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} seed length\n\t*/\n\tfunction getSeedLength() {\n\t\treturn rand.PRNG.seedLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state length\n\t*/\n\tfunction getStateLength() {\n\t\treturn rand.PRNG.stateLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state size (in bytes).\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state size (in bytes)\n\t*/\n\tfunction getStateSize() {\n\t\treturn rand.PRNG.byteLength;\n\t}\n\n\t/**\n\t* Returns the current pseudorandom number generator state.\n\t*\n\t* @private\n\t* @returns {PRNGStateMT19937} current state\n\t*/\n\tfunction getState() {\n\t\treturn rand.PRNG.state;\n\t}\n\n\t/**\n\t* Sets the pseudorandom number generator state.\n\t*\n\t* @private\n\t* @param {PRNGStateMT19937} s - generator state\n\t* @throws {Error} must provide a valid state\n\t*/\n\tfunction setState( s ) {\n\t\trand.PRNG.state = s;\n\t}\n}\n\n\n// EXPORTS //\n\nmodule.exports = factory;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @name uniform\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\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 = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar uniform = factory();\n\n\n// EXPORTS //\n\nmodule.exports = uniform;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @module @stdlib/random-array-uniform\n*\n* @example\n* var uniform = require( '@stdlib/random-array-uniform' );\n*\n* var arr = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var uniform = require( '@stdlib/random-array-uniform' );\n*\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* var uniform = require( '@stdlib/random-array-uniform' );\n*\n* var rand = uniform.factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* var uniform = require( '@stdlib/random-array-uniform' );\n*\n* var rand = uniform.factory( 2.0, 5.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\" }\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,GAAAC,EAAA,CAAAA,EAAA,SACC,MAAS,SACV,ICFA,IAAAC,EAAAC,EAAA,SAAAC,GAAAC,EAAA,cAsBA,IAAIC,EAAS,QAAS,uCAAwC,EAC1DC,EAAW,QAAS,gCAAiC,EACrDC,EAAa,QAAS,iCAAkC,EACxDC,EAAS,QAAS,uBAAwB,EAK1CC,EAASJ,EAAO,EACpBI,EAAO,KAAM,SAAU,EAwBvB,SAASC,EAAUC,EAAMC,EAAU,CAClC,OAAMN,EAAUM,CAAQ,EAGnBL,EAAYK,EAAS,OAAQ,IACjCD,EAAK,MAAQC,EAAQ,MAChBH,EAAO,QAASE,EAAK,KAAM,EAAI,GAC5B,IAAI,UAAWH,EAAQ,gFAAiF,QAASC,EAAO,KAAM,MAAO,EAAGE,EAAK,KAAM,CAAE,EAGvJ,KARC,IAAI,UAAWH,EAAQ,qEAAsEI,CAAQ,CAAE,CAShH,CAKAR,EAAO,QAAUM,ICvEjB,IAAAG,EAAAC,EAAA,SAAAC,GAAAC,EAAA,cAsBA,IAAIC,EAAuB,QAAS,uCAAwC,EAAE,YAC1EC,EAAc,QAAS,uDAAwD,EAC/EC,EAAsB,QAAS,uDAAwD,EACvFC,EAAuB,QAAS,wDAAyD,EACzFC,EAAmB,QAAS,iCAAkC,EAC9DC,EAAO,QAAS,oBAAqB,EACrCC,EAAO,QAAS,6BAA8B,EAC9CC,EAAQ,QAAS,sCAAuC,EACxDC,EAAW,QAAS,8BAA+B,EACnDC,EAAU,QAAS,8BAA+B,EAClDC,EAAS,QAAS,6BAA8B,EAChDC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IACXC,EAAW,IAwCf,SAASC,IAAU,CAClB,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EAOJ,GALAH,EAAO,CACN,MAASL,EAAS,KACnB,EAEAI,EAAQ,UAAU,OACbA,IAAU,EACdG,EAAOb,EACPY,EAAOG,UACIL,IAAU,EAAI,CAIzB,GAHAD,EAAU,UAAW,CAAE,EACvBI,EAAOb,EAAK,QAASS,CAAQ,EAC7BK,EAAMP,EAAUI,EAAMF,CAAQ,EACzBK,EACJ,MAAMA,EAEPF,EAAOG,CACR,SAAYL,IAAU,EACrBG,EAAOb,EAAK,QAAS,UAAW,CAAE,EAAG,UAAW,CAAE,CAAE,EACpDY,EAAOI,UACIN,IAAU,EAAI,CAIzB,GAHAD,EAAU,UAAW,CAAE,EACvBI,EAAOb,EAAK,QAAS,UAAW,CAAE,EAAG,UAAW,CAAE,EAAGS,CAAQ,EAC7DK,EAAMP,EAAUI,EAAMF,CAAQ,EACzBK,EACJ,MAAMA,EAEPF,EAAOI,CACR,CACA,OAAKP,GAAWA,EAAQ,MACvBd,EAAaiB,EAAM,OAAQ,IAAK,EAChCjB,EAAaiB,EAAM,aAAc,IAAK,EACtCf,EAAsBe,EAAM,QAASd,EAAkB,IAAK,EAAGC,CAAK,EACpEJ,EAAaiB,EAAM,cAAe,IAAK,EACvCjB,EAAaiB,EAAM,aAAc,IAAK,IAEtChB,EAAqBgB,EAAM,OAAQK,CAAQ,EAC3CrB,EAAqBgB,EAAM,aAAcM,CAAc,EACvDrB,EAAsBe,EAAM,QAASO,EAAUC,CAAS,EACxDxB,EAAqBgB,EAAM,cAAeS,CAAe,EACzDzB,EAAqBgB,EAAM,aAAcU,CAAa,GAEvD3B,EAAaiB,EAAM,OAAQC,EAAK,IAAK,EAC9BD,EAcP,SAASI,EAAUO,EAAKd,EAAU,CACjC,IAAIe,EACAC,EACAX,EACAY,EACAC,EACJ,GAAK,CAACjC,EAAsB6B,CAAI,EAC/B,MAAM,IAAI,UAAWlB,EAAQ,+EAAgFkB,CAAI,CAAE,EAGpH,GADAI,EAAI,CAAC,EACA,UAAU,OAAS,IACvBb,EAAMP,EAAUoB,EAAGlB,CAAQ,EACtBK,GACJ,MAAMA,EAIR,OADAY,EAAKC,EAAE,OAAShB,EAAK,MAChBe,IAAO,UACJxB,EAAUqB,EAAKV,CAAK,GAE5BW,EAAOvB,EAAOyB,CAAG,EACjBD,EAAM,IAAID,EAAMD,CAAI,EACpBpB,EAAS,CAAEsB,CAAI,EAAG,CAAEF,CAAI,EAAG,CAAE,CAAE,EAAGV,CAAK,EAChCY,EACR,CAgBA,SAASV,EAAUQ,EAAKK,EAAGC,EAAGpB,EAAU,CACvC,IAAIe,EACAC,EACAX,EACAY,EACAC,EACJ,GAAK,CAACjC,EAAsB6B,CAAI,EAC/B,MAAM,IAAI,UAAWlB,EAAQ,+EAAgFkB,CAAI,CAAE,EAGpH,GADAI,EAAI,CAAC,EACA,UAAU,OAAS,IACvBb,EAAMP,EAAUoB,EAAGlB,CAAQ,EACtBK,GACJ,MAAMA,EAKR,GADAY,EAAKC,EAAE,OAAShB,EAAK,MAChBe,IAAO,UACX,OAAOxB,EAAUqB,EAAKO,CAAQ,EAE/B,OAAAN,EAAOvB,EAAOyB,CAAG,EACjBD,EAAM,IAAID,EAAMD,CAAI,EACpBnB,EAAQ,CAAE,CAAEwB,CAAE,EAAG,CAAEC,CAAE,EAAGJ,CAAI,EAAG,CAAEF,CAAI,EAAG,CAAE,EAAG,EAAG,CAAE,EAAGV,CAAK,EACnDY,EAQP,SAASK,GAAU,CAClB,OAAOjB,EAAMe,EAAGC,CAAE,CACnB,CACD,CAQA,SAASZ,GAAU,CAClB,OAAOL,EAAK,KAAK,IAClB,CAQA,SAASM,GAAgB,CACxB,OAAON,EAAK,KAAK,UAClB,CAQA,SAASS,GAAiB,CACzB,OAAOT,EAAK,KAAK,WAClB,CAQA,SAASU,GAAe,CACvB,OAAOV,EAAK,KAAK,UAClB,CAQA,SAASO,GAAW,CACnB,OAAOP,EAAK,KAAK,KAClB,CASA,SAASQ,EAAUW,EAAI,CACtBnB,EAAK,KAAK,MAAQmB,CACnB,CACD,CAKAtC,EAAO,QAAUe,KCzRjB,IAAAwB,EAAAC,EAAA,SAAAC,GAAAC,EAAA,cAsBA,IAAIC,GAAU,IA8BVC,GAAUD,GAAQ,EAKtBD,EAAO,QAAUE,KCKjB,IAAIC,GAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,GAAU,IAKdF,GAAaC,EAAM,UAAWC,EAAQ,EAKtC,OAAO,QAAUD", - "names": ["require_defaults", "__commonJSMin", "exports", "module", "require_validate", "__commonJSMin", "exports", "module", "dtypes", "isObject", "hasOwnProp", "format", "DTYPES", "validate", "opts", "options", "require_factory", "__commonJSMin", "exports", "module", "isNonNegativeInteger", "setReadOnly", "setReadOnlyAccessor", "setReadWriteAccessor", "constantFunction", "noop", "base", "ctors", "filledBy", "nullary", "binary", "format", "defaults", "validate", "factory", "options", "nargs", "opts", "rand", "prng", "err", "uniform2", "uniform1", "getSeed", "getSeedLength", "getState", "setState", "getStateLength", "getStateSize", "len", "ctor", "out", "dt", "o", "a", "b", "wrapper", "s", "require_main", "__commonJSMin", "exports", "module", "factory", "uniform", "setReadOnly", "main", "factory"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 256216a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,169 +0,0 @@ - -{{alias}}( len, a, b[, options] ) - Returns an array containing pseudorandom numbers drawn from a continuous - uniform distribution. - - Parameters - ---------- - len: integer - Output array length. - - a: number - Minimum support. - - b: number - Maximum support. - - 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 ) - - - -{{alias}}.factory( [a, b, ][options] ) - Returns a function for creating arrays containing pseudorandom numbers drawn - from a continuous uniform distribution. - - If provided `a` and `b`, the returned function returns random variates drawn - from the specified distribution. - - If not provided `a` and `b`, the returned function requires that both `a` - and `b` 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. - - 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 ) - - - // Provide distribution parameters: - > fcn = {{alias}}.factory( 2.0, 5.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 ) - - - // Get a copy of the current state: - > var state = {{alias}}.state - - - > out = {{alias}}( 3, 2.0, 5.0 ) - - > out = {{alias}}( 3, 2.0, 5.0 ) - - - // Set the state: - > {{alias}}.state = state; - - // Regenerate a previous array: - > out = {{alias}}( 3, 2.0, 5.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 a087b98..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,355 +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. -*/ - -import random = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - random( 10, 2, 3 ); // $ExpectType RandomArray - random( 10, 1, 2 ); // $ExpectType RandomArray - random( 10, 1, 2, {} ); // $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 ); // $ExpectError - random( true, 2.0, 5.0 ); // $ExpectError - random( false, 2.0, 5.0 ); // $ExpectError - random( null, 2.0, 5.0 ); // $ExpectError - random( [], 2.0, 5.0 ); // $ExpectError - random( {}, 2.0, 5.0 ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - random( '5', 2.0, 5.0, {} ); // $ExpectError - random( true, 2.0, 5.0, {} ); // $ExpectError - random( false, 2.0, 5.0, {} ); // $ExpectError - random( null, 2.0, 5.0, {} ); // $ExpectError - random( [], 2.0, 5.0, {} ); // $ExpectError - random( {}, 2.0, 5.0, {} ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.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 ); // $ExpectError - random( 10, true, 5.0 ); // $ExpectError - random( 10, false, 5.0 ); // $ExpectError - random( 10, null, 5.0 ); // $ExpectError - random( 10, [], 5.0 ); // $ExpectError - random( 10, {}, 5.0 ); // $ExpectError - random( 10, ( x: number ): number => x, 5.0 ); // $ExpectError - - random( 10, '5', 5.0, {} ); // $ExpectError - random( 10, true, 5.0, {} ); // $ExpectError - random( 10, false, 5.0, {} ); // $ExpectError - random( 10, null, 5.0, {} ); // $ExpectError - random( 10, [], 5.0, {} ); // $ExpectError - random( 10, {}, 5.0, {} ); // $ExpectError - random( 10, ( x: number ): number => x, 5.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' ); // $ExpectError - random( 10, 2.0, true ); // $ExpectError - random( 10, 2.0, false ); // $ExpectError - random( 10, 2.0, null ); // $ExpectError - random( 10, 2.0, [] ); // $ExpectError - random( 10, 2.0, {} ); // $ExpectError - random( 10, 2.0, ( x: number ): number => x ); // $ExpectError - - random( 10, 2.0, '5', {} ); // $ExpectError - random( 10, 2.0, true, {} ); // $ExpectError - random( 10, 2.0, false, {} ); // $ExpectError - random( 10, 2.0, null, {} ); // $ExpectError - random( 10, 2.0, [], {} ); // $ExpectError - random( 10, 2.0, {}, {} ); // $ExpectError - random( 10, 2.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, '5' ); // $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, [] ); // $ExpectError - random( 10, 2.0, 5.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, { 'dtype': 123 } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': null } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - random( 10, 2.0, 5.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 -} - -// Attached to main export is a `factory` method which returns a function... -{ - random.factory( 2.0, 5.0 ); // $ExpectType UnaryFunction - random.factory( 2.0, 5.0, { 'copy': false } ); // $ExpectType UnaryFunction - - random.factory(); // $ExpectType TernaryFunction - random.factory( { 'copy': false } ); // $ExpectType TernaryFunction -} - -// The `factory` method returns a function which returns an array... -{ - const fcn1 = random.factory( 2.0, 5.0 ); - fcn1( 10 ); // $ExpectType RandomArray - - const fcn2 = random.factory(); - fcn2( 10, 2.0, 5.0 ); // $ExpectType RandomArray -} - -// The compiler throws an error if the `factory` method is provided invalid arguments... -{ - random.factory( '5', 5.0 ); // $ExpectError - random.factory( true, 5.0 ); // $ExpectError - random.factory( false, 5.0 ); // $ExpectError - random.factory( [], 5.0 ); // $ExpectError - random.factory( {}, 5.0 ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0 ); // $ExpectError - - random.factory( '5', 5.0, {} ); // $ExpectError - random.factory( true, 5.0, {} ); // $ExpectError - random.factory( false, 5.0, {} ); // $ExpectError - random.factory( [], 5.0, {} ); // $ExpectError - random.factory( {}, 5.0, {} ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0, {} ); // $ExpectError - - random.factory( 2.0, '5' ); // $ExpectError - random.factory( 2.0, true ); // $ExpectError - random.factory( 2.0, false ); // $ExpectError - random.factory( 2.0, [] ); // $ExpectError - random.factory( 2.0, {} ); // $ExpectError - random.factory( 2.0, ( x: number ): number => x ); // $ExpectError - - random.factory( 2.0, '5', {} ); // $ExpectError - random.factory( 2.0, true, {} ); // $ExpectError - random.factory( 2.0, false, {} ); // $ExpectError - random.factory( 2.0, [], {} ); // $ExpectError - random.factory( 2.0, {}, {} ); // $ExpectError - random.factory( 2.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, 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, { 'prng': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'seed': true } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': [ 'a' ] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'state': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': {} } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': true ); // $ExpectError - random.factory( 2.0, 5.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, { 'copy': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'dtype': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - random.factory( 2.0, 5.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, {}, {} ); // $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 ); - 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 ); // $ExpectError - fcn2( false, 2.0, 5.0 ); // $ExpectError - fcn2( '5', 2.0, 5.0 ); // $ExpectError - fcn2( [], 2.0, 5.0 ); // $ExpectError - fcn2( {}, 2.0, 5.0 ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - fcn2( true, 2.0, 5.0, {} ); // $ExpectError - fcn2( false, 2.0, 5.0, {} ); // $ExpectError - fcn2( '5', 2.0, 5.0, {} ); // $ExpectError - fcn2( [], 2.0, 5.0, {} ); // $ExpectError - fcn2( {}, 2.0, 5.0, {} ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0, {} ); // $ExpectError - - fcn2( 10, true, 5.0 ); // $ExpectError - fcn2( 10, false, 5.0 ); // $ExpectError - fcn2( 10, '5', 5.0 ); // $ExpectError - fcn2( 10, [], 5.0 ); // $ExpectError - fcn2( 10, {}, 5.0 ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0 ); // $ExpectError - - fcn2( 10, true, 5.0, {} ); // $ExpectError - fcn2( 10, false, 5.0, {} ); // $ExpectError - fcn2( 10, '5', 5.0, {} ); // $ExpectError - fcn2( 10, [], 5.0, {} ); // $ExpectError - fcn2( 10, {}, 5.0, {} ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0, {} ); // $ExpectError - - fcn2( 10, 2.0, true ); // $ExpectError - fcn2( 10, 2.0, false ); // $ExpectError - fcn2( 10, 2.0, '5' ); // $ExpectError - fcn2( 10, 2.0, [] ); // $ExpectError - fcn2( 10, 2.0, {} ); // $ExpectError - fcn2( 10, 2.0, ( x: number ): number => x ); // $ExpectError - - fcn2( 10, 2.0, true, {} ); // $ExpectError - fcn2( 10, 2.0, false, {} ); // $ExpectError - fcn2( 10, 2.0, '5', {} ); // $ExpectError - fcn2( 10, 2.0, [], {} ); // $ExpectError - fcn2( 10, 2.0, {}, {} ); // $ExpectError - fcn2( 10, 2.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, { 'dtype': 123 } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': null } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError - - const fcn2 = random.factory( 2.0, 5.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 ); - fcn1(); // $ExpectError - fcn1( 1, 1, 1 ); // $ExpectError - - const fcn2 = random.factory(); - fcn2(); // $ExpectError - fcn2( 1 ); // $ExpectError - fcn2( 1, 1, 1, 1 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index c485546..0000000 --- a/examples/index.js +++ /dev/null @@ -1,48 +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'; - -var logEach = require( '@stdlib/console-log-each' ); -var uniform = require( './../lib' ); - -// Create a function for generating random arrays originating from the same state: -var random = uniform.factory( 2.0, 5.0, { - 'state': uniform.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 = uniform.factory( 2.0, 5.0, { - 'state': uniform.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 807b033..8f3c81f 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { RealFloatingPointDataType, 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..5d2cd91 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.1.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-accessor@v0.1.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-write-accessor@v0.1.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-constant-function@v0.1.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-noop@v0.1.1-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/random-base-uniform@v0.1.0-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-typed-real-float-ctors@v0.1.0-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@v0.1.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-nullary@v0.1.0-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@v0.1.0-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/string-format@v0.1.1-esm/index.mjs";import f from"https://cdn.jsdelivr.net/gh/stdlib-js/array-typed-real-float-dtypes@v0.1.1-esm/index.mjs";import u from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.1.0-esm/index.mjs";import h from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.1.1-esm/index.mjs";var j="float64",g=f();function c(e,t){return u(t)?h(t,"dtype")&&(e.dtype=t.dtype,g.indexOf(e.dtype)<0)?new TypeError(p('invalid option. `%s` option must be one of the following: "%s". Option: `%s`.',"dtype",g.join('", "'),e.dtype)):null:new TypeError(p("invalid argument. Options argument must be an object. Value: `%s`.",t))}function v(){var f,u,h,g,v,y;if(h={dtype:j},0===(u=arguments.length))v=d,g=x;else if(1===u){if(f=arguments[0],v=d.factory(f),y=c(h,f))throw y;g=x}else if(2===u)v=d.factory(arguments[0],arguments[1]),g=b;else if(3===u){if(f=arguments[2],v=d.factory(arguments[0],arguments[1],f),y=c(h,f))throw y;g=b}return f&&f.prng?(e(g,"seed",null),e(g,"seedLength",null),s(g,"state",r(null),i),e(g,"stateLength",null),e(g,"byteLength",null)):(n(g,"seed",w),n(g,"seedLength",L),s(g,"state",P,R),n(g,"stateLength",G),n(g,"byteLength",N)),e(g,"PRNG",v.PRNG),g;function b(e,n){var s,r,i,d;if(!t(e))throw new TypeError(p("invalid argument. First argument must be a nonnegative integer. Value: `%s`.",e));if(d={},arguments.length>1&&(r=c(d,n)))throw r;return"generic"===(i=d.dtype||h.dtype)?l(e,v):(s=new(o(i))(e),m([s],[e],[1],v),s)}function x(e,n,s,r){var i,d,m,f;if(!t(e))throw new TypeError(p("invalid argument. First argument must be a nonnegative integer. Value: `%s`.",e));if(f={},arguments.length>3&&(d=c(f,r)))throw d;return"generic"===(m=f.dtype||h.dtype)?l(e,u):(i=new(o(m))(e),a([[n],[s],i],[e],[0,0,1],v),i);function u(){return v(n,s)}}function w(){return g.PRNG.seed}function L(){return g.PRNG.seedLength}function G(){return g.PRNG.stateLength}function N(){return g.PRNG.byteLength}function P(){return g.PRNG.state}function R(e){g.PRNG.state=e}}g.push("generic");var y=v();e(y,"factory",v);export{y as default,v as factory}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..b4fe4ef --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/factory.js","../lib/main.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 dtypes from '@stdlib/array-typed-real-float-dtypes';\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport format from '@stdlib/string-format';\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes();\nDTYPES.push( 'generic' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( DTYPES.indexOf( opts.dtype ) < 0 ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be one of the following: \"%s\". Option: `%s`.', 'dtype', DTYPES.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport setReadOnlyAccessor from '@stdlib/utils-define-nonenumerable-read-only-accessor';\nimport setReadWriteAccessor from '@stdlib/utils-define-nonenumerable-read-write-accessor';\nimport constantFunction from '@stdlib/utils-constant-function';\nimport noop from '@stdlib/utils-noop';\nimport base from '@stdlib/random-base-uniform';\nimport ctors from '@stdlib/array-typed-real-float-ctors';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport nullary from '@stdlib/strided-base-nullary';\nimport binary from '@stdlib/strided-base-binary';\nimport format from '@stdlib/string-format';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution.\n*\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\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 {RangeError} `a` must be less than `b`\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 uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10 );\n* // returns \n*\n* @example\n* var uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nfunction factory() {\n\tvar options;\n\tvar nargs;\n\tvar opts;\n\tvar rand;\n\tvar prng;\n\tvar err;\n\n\topts = {\n\t\t'dtype': defaults.dtype\n\t};\n\n\tnargs = arguments.length;\n\tif ( nargs === 0 ) {\n\t\tprng = base;\n\t\trand = uniform2;\n\t} else if ( nargs === 1 ) {\n\t\toptions = arguments[ 0 ];\n\t\tprng = base.factory( options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform2;\n\t} else if ( nargs === 2 ) {\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ] );\n\t\trand = uniform1;\n\t} else if ( nargs === 3 ) {\n\t\toptions = arguments[ 2 ];\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ], options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform1;\n\t}\n\tif ( options && options.prng ) {\n\t\tsetReadOnly( rand, 'seed', null );\n\t\tsetReadOnly( rand, 'seedLength', null );\n\t\tsetReadWriteAccessor( rand, 'state', constantFunction( null ), noop );\n\t\tsetReadOnly( rand, 'stateLength', null );\n\t\tsetReadOnly( rand, 'byteLength', null );\n\t} else {\n\t\tsetReadOnlyAccessor( rand, 'seed', getSeed );\n\t\tsetReadOnlyAccessor( rand, 'seedLength', getSeedLength );\n\t\tsetReadWriteAccessor( rand, 'state', getState, setState );\n\t\tsetReadOnlyAccessor( rand, 'stateLength', getStateLength );\n\t\tsetReadOnlyAccessor( rand, 'byteLength', getStateSize );\n\t}\n\tsetReadOnly( rand, 'PRNG', prng.PRNG );\n\treturn rand;\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform1( len, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 1 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, prng );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tnullary( [ out ], [ len ], [ 1 ], prng );\n\t\treturn out;\n\t}\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {number} a - minimum support\n\t* @param {number} b - maximum support\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform2( len, a, b, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 3 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\t// NOTE: we could alternatively use the PRNG factory function to create a PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. Decision made here to avoid this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom number. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in a return value of `NaN`.\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, wrapper );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tbinary( [ [ a ], [ b ], out ], [ len ], [ 0, 0, 1 ], prng );\n\t\treturn out;\n\n\t\t/**\n\t\t* Applies parameters to a pseudorandom number generator function.\n\t\t*\n\t\t* @private\n\t\t* @returns {number} pseudorandom number\n\t\t*/\n\t\tfunction wrapper() {\n\t\t\treturn prng( a, b );\n\t\t}\n\t}\n\n\t/**\n\t* Returns the PRNG seed.\n\t*\n\t* @private\n\t* @returns {PRNGSeedMT19937} seed\n\t*/\n\tfunction getSeed() {\n\t\treturn rand.PRNG.seed;\n\t}\n\n\t/**\n\t* Returns the PRNG seed length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} seed length\n\t*/\n\tfunction getSeedLength() {\n\t\treturn rand.PRNG.seedLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state length\n\t*/\n\tfunction getStateLength() {\n\t\treturn rand.PRNG.stateLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state size (in bytes).\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state size (in bytes)\n\t*/\n\tfunction getStateSize() {\n\t\treturn rand.PRNG.byteLength;\n\t}\n\n\t/**\n\t* Returns the current pseudorandom number generator state.\n\t*\n\t* @private\n\t* @returns {PRNGStateMT19937} current state\n\t*/\n\tfunction getState() {\n\t\treturn rand.PRNG.state;\n\t}\n\n\t/**\n\t* Sets the pseudorandom number generator state.\n\t*\n\t* @private\n\t* @param {PRNGStateMT19937} s - generator state\n\t* @throws {Error} must provide a valid state\n\t*/\n\tfunction setState( s ) {\n\t\trand.PRNG.state = s;\n\t}\n}\n\n\n// EXPORTS //\n\nexport default factory;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @name uniform\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\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 = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar uniform = factory();\n\n\n// EXPORTS //\n\nexport default uniform;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @module @stdlib/random-array-uniform\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.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\" }\n"],"names":["DTYPES","dtypes","validate","opts","options","isObject","hasOwnProp","dtype","indexOf","TypeError","format","join","factory","nargs","rand","prng","err","defaults","arguments","length","base","uniform2","uniform1","setReadOnly","setReadWriteAccessor","constantFunction","noop","setReadOnlyAccessor","getSeed","getSeedLength","getState","setState","getStateLength","getStateSize","PRNG","len","out","dt","o","isNonNegativeInteger","filledBy","ctors","nullary","a","b","wrapper","binary","seed","seedLength","stateLength","byteLength","state","s","push","uniform","main"],"mappings":";;2gDA8BIA,EAASC,IAyBb,SAASC,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,WACzBD,EAAKI,MAAQH,EAAQG,MAChBP,EAAOQ,QAASL,EAAKI,OAAU,GAC5B,IAAIE,UAAWC,EAAQ,gFAAiF,QAASV,EAAOW,KAAM,QAAUR,EAAKI,QAG/I,KARC,IAAIE,UAAWC,EAAQ,qEAAsEN,GAStG,CCSA,SAASQ,IACR,IAAIR,EACAS,EACAV,EACAW,EACAC,EACAC,EAOJ,GALAb,EAAO,CACNI,MAASU,GAIK,KADfJ,EAAQK,UAAUC,QAEjBJ,EAAOK,EACPN,EAAOO,OACD,GAAe,IAAVR,EAAc,CAIzB,GAHAT,EAAUc,UAAW,GACrBH,EAAOK,EAAKR,QAASR,GACrBY,EAAMd,EAAUC,EAAMC,GAErB,MAAMY,EAEPF,EAAOO,CACT,MAAQ,GAAe,IAAVR,EACXE,EAAOK,EAAKR,QAASM,UAAW,GAAKA,UAAW,IAChDJ,EAAOQ,OACD,GAAe,IAAVT,EAAc,CAIzB,GAHAT,EAAUc,UAAW,GACrBH,EAAOK,EAAKR,QAASM,UAAW,GAAKA,UAAW,GAAKd,GACrDY,EAAMd,EAAUC,EAAMC,GAErB,MAAMY,EAEPF,EAAOQ,CACP,CAeD,OAdKlB,GAAWA,EAAQW,MACvBQ,EAAaT,EAAM,OAAQ,MAC3BS,EAAaT,EAAM,aAAc,MACjCU,EAAsBV,EAAM,QAASW,EAAkB,MAAQC,GAC/DH,EAAaT,EAAM,cAAe,MAClCS,EAAaT,EAAM,aAAc,QAEjCa,EAAqBb,EAAM,OAAQc,GACnCD,EAAqBb,EAAM,aAAce,GACzCL,EAAsBV,EAAM,QAASgB,EAAUC,GAC/CJ,EAAqBb,EAAM,cAAekB,GAC1CL,EAAqBb,EAAM,aAAcmB,IAE1CV,EAAaT,EAAM,OAAQC,EAAKmB,MACzBpB,EAcP,SAASQ,EAAUa,EAAK/B,GACvB,IACIgC,EACApB,EACAqB,EACAC,EACJ,IAAMC,EAAsBJ,GAC3B,MAAM,IAAI1B,UAAWC,EAAQ,+EAAgFyB,IAG9G,GADAG,EAAI,CAAA,EACCpB,UAAUC,OAAS,IACvBH,EAAMd,EAAUoC,EAAGlC,IAElB,MAAMY,EAIR,MAAY,aADZqB,EAAKC,EAAE/B,OAASJ,EAAKI,OAEbiC,EAAUL,EAAKpB,IAGvBqB,EAAM,IADCK,EAAOJ,GACR,CAAUF,GAChBO,EAAS,CAAEN,GAAO,CAAED,GAAO,CAAE,GAAKpB,GAC3BqB,EACP,CAgBD,SAASf,EAAUc,EAAKQ,EAAGC,EAAGxC,GAC7B,IACIgC,EACApB,EACAqB,EACAC,EACJ,IAAMC,EAAsBJ,GAC3B,MAAM,IAAI1B,UAAWC,EAAQ,+EAAgFyB,IAG9G,GADAG,EAAI,CAAA,EACCpB,UAAUC,OAAS,IACvBH,EAAMd,EAAUoC,EAAGlC,IAElB,MAAMY,EAKR,MAAY,aADZqB,EAAKC,EAAE/B,OAASJ,EAAKI,OAEbiC,EAAUL,EAAKU,IAGvBT,EAAM,IADCK,EAAOJ,GACR,CAAUF,GAChBW,EAAQ,CAAE,CAAEH,GAAK,CAAEC,GAAKR,GAAO,CAAED,GAAO,CAAE,EAAG,EAAG,GAAKpB,GAC9CqB,GAQP,SAASS,IACR,OAAO9B,EAAM4B,EAAGC,EAChB,CACD,CAQD,SAAShB,IACR,OAAOd,EAAKoB,KAAKa,IACjB,CAQD,SAASlB,IACR,OAAOf,EAAKoB,KAAKc,UACjB,CAQD,SAAShB,IACR,OAAOlB,EAAKoB,KAAKe,WACjB,CAQD,SAAShB,IACR,OAAOnB,EAAKoB,KAAKgB,UACjB,CAQD,SAASpB,IACR,OAAOhB,EAAKoB,KAAKiB,KACjB,CASD,SAASpB,EAAUqB,GAClBtC,EAAKoB,KAAKiB,MAAQC,CAClB,CACF,CDrPApD,EAAOqD,KAAM,WEqBV,IAACC,EAAU1C,ICiBdW,EAAAgC,EAAA,UAAA3C"} \ No newline at end of file diff --git a/lib/defaults.json b/lib/defaults.json deleted file mode 100644 index 83f4438..0000000 --- a/lib/defaults.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "dtype": "float64" -} diff --git a/lib/factory.js b/lib/factory.js deleted file mode 100644 index 22ec236..0000000 --- a/lib/factory.js +++ /dev/null @@ -1,282 +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 isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var setReadOnlyAccessor = require( '@stdlib/utils-define-nonenumerable-read-only-accessor' ); -var setReadWriteAccessor = require( '@stdlib/utils-define-nonenumerable-read-write-accessor' ); -var constantFunction = require( '@stdlib/utils-constant-function' ); -var noop = require( '@stdlib/utils-noop' ); -var base = require( '@stdlib/random-base-uniform' ); -var ctors = require( '@stdlib/array-typed-real-float-ctors' ); -var filledBy = require( '@stdlib/array-base-filled-by' ); -var nullary = require( '@stdlib/strided-base-nullary' ); -var binary = require( '@stdlib/strided-base-binary' ); -var format = require( '@stdlib/string-format' ); -var defaults = require( './defaults.json' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution. -* -* @param {number} [a] - minimum support -* @param {number} [b] - maximum support -* @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 {RangeError} `a` must be less than `b` -* @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 uniform = factory( 2.0, 5.0 ); -* // returns -* -* var arr = uniform( 10 ); -* // returns -* -* @example -* var uniform = factory( 2.0, 5.0 ); -* // returns -* -* var arr = uniform( 10, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -function factory() { - var options; - var nargs; - var opts; - var rand; - var prng; - var err; - - opts = { - 'dtype': defaults.dtype - }; - - nargs = arguments.length; - if ( nargs === 0 ) { - prng = base; - rand = uniform2; - } else if ( nargs === 1 ) { - options = arguments[ 0 ]; - prng = base.factory( options ); - err = validate( opts, options ); - if ( err ) { - throw err; - } - rand = uniform2; - } else if ( nargs === 2 ) { - prng = base.factory( arguments[ 0 ], arguments[ 1 ] ); - rand = uniform1; - } else if ( nargs === 3 ) { - options = arguments[ 2 ]; - prng = base.factory( arguments[ 0 ], arguments[ 1 ], options ); - err = validate( opts, options ); - if ( err ) { - throw err; - } - rand = uniform1; - } - if ( options && options.prng ) { - setReadOnly( rand, 'seed', null ); - setReadOnly( rand, 'seedLength', null ); - setReadWriteAccessor( rand, 'state', constantFunction( null ), noop ); - setReadOnly( rand, 'stateLength', null ); - setReadOnly( rand, 'byteLength', null ); - } else { - setReadOnlyAccessor( rand, 'seed', getSeed ); - setReadOnlyAccessor( rand, 'seedLength', getSeedLength ); - setReadWriteAccessor( rand, 'state', getState, setState ); - setReadOnlyAccessor( rand, 'stateLength', getStateLength ); - setReadOnlyAccessor( rand, 'byteLength', getStateSize ); - } - setReadOnly( rand, 'PRNG', prng.PRNG ); - return rand; - - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @private - * @param {NonNegativeInteger} len - array length - * @param {Options} [options] - function options - * @param {string} [options.dtype] - 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 - */ - function uniform1( len, options ) { - var ctor; - var out; - var err; - var dt; - var o; - if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) ); - } - o = {}; - if ( arguments.length > 1 ) { - err = validate( o, options ); - if ( err ) { - throw err; - } - } - dt = o.dtype || opts.dtype; - if ( dt === 'generic' ) { - return filledBy( len, prng ); - } - ctor = ctors( dt ); - out = new ctor( len ); - nullary( [ out ], [ len ], [ 1 ], prng ); - return out; - } - - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @private - * @param {NonNegativeInteger} len - array length - * @param {number} a - minimum support - * @param {number} b - maximum support - * @param {Options} [options] - function options - * @param {string} [options.dtype] - 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 - */ - function uniform2( len, a, b, options ) { - var ctor; - var out; - var err; - var dt; - var o; - if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) ); - } - o = {}; - if ( arguments.length > 3 ) { - err = validate( o, options ); - if ( err ) { - throw err; - } - } - // NOTE: we could alternatively use the PRNG factory function to create a PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. Decision made here to avoid this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom number. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in a return value of `NaN`. - dt = o.dtype || opts.dtype; - if ( dt === 'generic' ) { - return filledBy( len, wrapper ); - } - ctor = ctors( dt ); - out = new ctor( len ); - binary( [ [ a ], [ b ], out ], [ len ], [ 0, 0, 1 ], prng ); - return out; - - /** - * Applies parameters to a pseudorandom number generator function. - * - * @private - * @returns {number} pseudorandom number - */ - function wrapper() { - return prng( a, b ); - } - } - - /** - * Returns the PRNG seed. - * - * @private - * @returns {PRNGSeedMT19937} seed - */ - function getSeed() { - return rand.PRNG.seed; - } - - /** - * Returns the PRNG seed length. - * - * @private - * @returns {PositiveInteger} seed length - */ - function getSeedLength() { - return rand.PRNG.seedLength; - } - - /** - * Returns the PRNG state length. - * - * @private - * @returns {PositiveInteger} state length - */ - function getStateLength() { - return rand.PRNG.stateLength; - } - - /** - * Returns the PRNG state size (in bytes). - * - * @private - * @returns {PositiveInteger} state size (in bytes) - */ - function getStateSize() { - return rand.PRNG.byteLength; - } - - /** - * Returns the current pseudorandom number generator state. - * - * @private - * @returns {PRNGStateMT19937} current state - */ - function getState() { - return rand.PRNG.state; - } - - /** - * Sets the pseudorandom number generator state. - * - * @private - * @param {PRNGStateMT19937} s - generator state - * @throws {Error} must provide a valid state - */ - function setState( s ) { - rand.PRNG.state = s; - } -} - - -// EXPORTS // - -module.exports = factory; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 0077f00..0000000 --- a/lib/index.js +++ /dev/null @@ -1,77 +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'; - -/** -* Create an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. -* -* @module @stdlib/random-array-uniform -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var arr = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var arr = uniform( 10, 2.0, 5.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var rand = uniform.factory( 2.0, 5.0 ); -* // returns -* -* var arr = rand( 10 ); -* // returns -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var rand = uniform.factory( 2.0, 5.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" } diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index da0d9b1..0000000 --- a/lib/main.js +++ /dev/null @@ -1,58 +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 factory = require( './factory.js' ); - - -// MAIN // - -/** -* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. -* -* @name uniform -* @type {Function} -* @param {NonNegativeInteger} len - array length -* @param {number} a - minimum support -* @param {number} b - maximum support -* @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 = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var arr = uniform( 10, 2.0, 5.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -var uniform = factory(); - - -// EXPORTS // - -module.exports = uniform; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index 40b9723..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,72 +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 dtypes = require( '@stdlib/array-typed-real-float-dtypes' ); -var isObject = require( '@stdlib/assert-is-plain-object' ); -var hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var format = require( '@stdlib/string-format' ); - - -// VARIABLES // - -var DTYPES = dtypes(); -DTYPES.push( 'generic' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Options} options - function options -* @param {string} [options.dtype] - output array data type -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var options = { -* 'dtype': 'float64' -* }; -* var err = validate( opts, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); - } - if ( hasOwnProp( options, 'dtype' ) ) { - opts.dtype = options.dtype; - if ( DTYPES.indexOf( opts.dtype ) < 0 ) { - return new TypeError( format( 'invalid option. `%s` option must be one of the following: "%s". Option: `%s`.', 'dtype', DTYPES.join( '", "' ), opts.dtype ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index 69877a6..767a213 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 continuous uniform 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,55 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-filled-by": "^0.1.0", - "@stdlib/array-typed-real-float-ctors": "^0.1.0", - "@stdlib/array-typed-real-float-dtypes": "^0.1.1", - "@stdlib/assert-has-own-property": "^0.1.1", - "@stdlib/assert-is-nonnegative-integer": "^0.1.0", - "@stdlib/assert-is-plain-object": "^0.1.1", - "@stdlib/random-base-uniform": "^0.1.0", - "@stdlib/strided-base-binary": "^0.1.0", - "@stdlib/strided-base-nullary": "^0.1.0", - "@stdlib/error-tools-fmtprodmsg": "^0.1.1", - "@stdlib/types": "^0.2.0", - "@stdlib/utils-constant-function": "^0.1.1", - "@stdlib/utils-define-nonenumerable-read-only-accessor": "^0.1.1", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1", - "@stdlib/utils-define-nonenumerable-read-write-accessor": "^0.1.1", - "@stdlib/utils-noop": "^0.1.1" - }, - "devDependencies": { - "@stdlib/array-float32": "^0.1.1", - "@stdlib/array-float64": "^0.1.1", - "@stdlib/array-uint32": "^0.1.1", - "@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", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..bd80a2c --- /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.factory.js b/test/test.factory.js deleted file mode 100644 index a869e75..0000000 --- a/test/test.factory.js +++ /dev/null @@ -1,1328 +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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -tape( 'the function throws an error if the second distribution parameter is less than the first distribution parameter', function test( t ) { - var values; - var i; - - values = [ - [ 0.0, 0.0 ], - [ -2.0, -4.0 ], - [ 2.0, 1.0 ] - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( arr ) { - return function badValue() { - factory( arr[0], arr[1] ); - }; - } -}); - -tape( 'the function throws an error if the second distribution parameter is less than the first distribution parameter (options)', function test( t ) { - var values; - var i; - - values = [ - [ 0.0, 0.0 ], - [ -2.0, -4.0 ], - [ 2.0, 1.0 ] - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( arr ) { - return function badValue() { - factory( arr[0], arr[1], {} ); - }; - } -}); - -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, 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, { - '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, { - '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, { - '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, { - '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, { - '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, { - '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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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 ); - - 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 ); - - 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, { - '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 ); - - 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 ); - 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( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory(); - actual = random( 10, 2.0, 5.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( typeof actual[ i ], 'number', '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 ); - - 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 ); - - 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 ); - - 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 that generates `NaN` values if the first distribution parameter is greater than or equal to the second distribution parameter', function test( t ) { - var random; - var values; - var actual; - var i; - var j; - - random = factory(); - values = [ - [ 2.0, 1.0 ], - [ -3.0, -4.0 ], - [ 0.0, 0.0 ] - ]; - - for ( i = 0; i < values.length; i++ ) { - actual = random( 10, values[ i ][ 0 ], values[ i ][ 1 ] ); - for ( j = 0; j < actual.length; j++ ) { - t.strictEqual( isnan( actual[ j ] ), true, 'returns expected value when provided '+values[ 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, { - '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 ); - - 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, { - '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( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'float64' - }); - actual = random( 10, 2.0, 5.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( typeof actual[ i ], 'number', '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, { - '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( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'float32' - }); - actual = random( 10, 2.0, 5.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( typeof actual[ i ], 'number', '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, { - '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 ); - - 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, { - '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, { - '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 ); - - // 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, { - '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 ); - - // 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, { - '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 ); - - 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, { - 'prng': randu.normalized - }); - - randu = minstd.factory({ - 'seed': seed - }); - random2 = factory( 2.0, 5.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 ); - arr2 = random2( 10, 2.0, 5.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 c4fb6d3..0000000 --- a/test/test.js +++ /dev/null @@ -1,69 +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 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 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 37b0080..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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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, 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, { - '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 ); - - 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( typeof actual[ i ], 'number', '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, { - '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( typeof actual[ i ], 'number', '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, { - '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( typeof actual[ i ], 'number', '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, { - '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 ); - } - // Capture the current state: - state = random.state; - - // Move to a future state... - arr = random( 10, 2.0, 5.0 ); - for ( i = 0; i < 100; i++ ) { - random( 2, 2.0, 5.0 ); - } - // Set the state: - random.state = state; - - // Replay previously generated values: - t.deepEqual( random( 10, 2.0, 5.0 ), arr, 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.validate.js b/test/test.validate.js deleted file mode 100644 index 9fbe15f..0000000 --- a/test/test.validate.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 validate = require( './../lib/validate.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof validate, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function returns an error if provided an options argument which is not an object', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - void 0, - null, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, values[ i ] ); - t.equal( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns an error if provided a `dtype` option which is not a supported data type', function test( t ) { - var values; - var err; - var i; - - values = [ - '5', - -5, - NaN, - true, - false, - void 0, - null, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - err = validate( {}, { - 'dtype': values[ i ] - }); - t.equal( err instanceof TypeError, true, 'returns a type error when provided '+values[i] ); - } - t.end(); -}); - -tape( 'the function returns null if all options are valid', function test( t ) { - var options; - var opts; - var err; - - options = { - 'dtype': 'float64' - }; - opts = {}; - err = validate( opts, options ); - - t.equal( err, null, 'returns null' ); - t.deepEqual( opts, options, 'sets option values' ); - - t.end(); -}); - -tape( 'the function ignores unrecognized/unsupported options', function test( t ) { - var options; - var opts; - var err; - - options = { - 'beep': true, - 'boop': 'bop' - }; - opts = {}; - err = validate( opts, options ); - - t.equal( err, null, 'returns null' ); - t.deepEqual( opts, {}, 'does not set any option values' ); - t.end(); -}); From 21514792c74555539320de2eb1a4cc76f0e203bd Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 10 Jan 2024 04:25:34 +0000 Subject: [PATCH 52/82] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index d90549b..f38f80e 100644 --- a/package.json +++ b/package.json @@ -42,7 +42,8 @@ "@stdlib/random-array-tools-binary-factory": "^0.1.0", "@stdlib/random-base-uniform": "^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 9ab8a6b260f8fdf04618525c60006a8554d92ae1 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 10 Jan 2024 04:28:15 +0000 Subject: [PATCH 53/82] Remove files --- index.d.ts | 245 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6427 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 8f3c81f..0000000 --- a/index.d.ts +++ /dev/null @@ -1,245 +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. -*/ - -// TypeScript Version: 4.1 - -/// - -import { RealFloatingPointDataType, FloatTypedArray } from '@stdlib/types/array'; -import * as random from '@stdlib/types/random'; - -/** -* Supported data types. -*/ -type DataType = RealFloatingPointDataType | 'generic'; - -/** -* 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 continuous uniform distribution with pre-specified parameter values. -*/ -interface UnaryFunction extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @param len - array length - * @param options - function options - * @returns output array - */ - ( len: number, options?: Options ): RandomArray; -} - -/** -* Interface for generating pseudorandom numbers drawn from a continuous uniform distribution without pre-specified parameter values. -*/ -interface TernaryFunction extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @param len - array length - * @param a - minimum support - * @param b - maximum support - * @param options - function options - * @returns output array - */ - ( len: number, a: number, b: number, options?: Options ): RandomArray; -} - -/** -* Interface for generating pseudorandom numbers drawn from a uniform distribution. -*/ -interface Random extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. - * - * @param len - array length - * @param a - minimum support - * @param b - maximum support - * @param options - function options - * @returns output array - * - * @example - * var out = uniform( 10, 2.0, 5.0 ); - * // returns - */ - ( len: number, a: number, b: number, options?: Options ): RandomArray; - - /** - * Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution. - * - * ## Notes - * - * - When provided `a` and `b`, the returned function returns random variates drawn from the specified distribution. - * - * @param a - minimum support - * @param b - maximum support - * @param options - function options - * @throws `a` must be less than `b` - * @throws must provide a valid state - * @returns function for creating arrays - * - * @example - * var random = uniform.factory( 2.0, 5.0 ); - * - * var out = random( 10 ); - * // returns - * - * @example - * var random = uniform.factory( 2.0, 5.0, { - * 'seed': 297 - * }); - * var out = random( 10 ); - * // returns - */ - factory( a: number, b: number, options?: FactoryOptions ): UnaryFunction; - - /** - * Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution. - * - * ## Notes - * - * - When not provided `a` and `b`, the returned function requires that both `a` and `b` be provided at each invocation. - * - * @param options - function options - * @throws must provide a valid state - * @returns function for creating arrays - * - * @example - * var random = uniform.factory(); - * - * var out = random( 10, 2.0, 5.0 ); - * // returns - * - * @example - * var random = uniform.factory({ - * 'seed': 297 - * }); - * var out = random( 10, 2.0, 5.0 ); - * // returns - */ - factory( options?: FactoryOptions ): TernaryFunction; -} - -/** -* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`. -* -* @param len - array length -* @param a - minimum support -* @param b - maximum support -* @param options - function options -* @returns output array -* -* @example -* var out = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var random = uniform.factory( 2.0, 5.0 ); -* -* var out = random( 10 ); -* // returns -*/ -declare var uniform: Random; - - -// EXPORTS // - -export = uniform; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 5d2cd91..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";import{isPrimitive as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.1.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-accessor@v0.1.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-write-accessor@v0.1.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-constant-function@v0.1.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-noop@v0.1.1-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/random-base-uniform@v0.1.0-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-typed-real-float-ctors@v0.1.0-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@v0.1.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-nullary@v0.1.0-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@v0.1.0-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/string-format@v0.1.1-esm/index.mjs";import f from"https://cdn.jsdelivr.net/gh/stdlib-js/array-typed-real-float-dtypes@v0.1.1-esm/index.mjs";import u from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.1.0-esm/index.mjs";import h from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.1.1-esm/index.mjs";var j="float64",g=f();function c(e,t){return u(t)?h(t,"dtype")&&(e.dtype=t.dtype,g.indexOf(e.dtype)<0)?new TypeError(p('invalid option. `%s` option must be one of the following: "%s". Option: `%s`.',"dtype",g.join('", "'),e.dtype)):null:new TypeError(p("invalid argument. Options argument must be an object. Value: `%s`.",t))}function v(){var f,u,h,g,v,y;if(h={dtype:j},0===(u=arguments.length))v=d,g=x;else if(1===u){if(f=arguments[0],v=d.factory(f),y=c(h,f))throw y;g=x}else if(2===u)v=d.factory(arguments[0],arguments[1]),g=b;else if(3===u){if(f=arguments[2],v=d.factory(arguments[0],arguments[1],f),y=c(h,f))throw y;g=b}return f&&f.prng?(e(g,"seed",null),e(g,"seedLength",null),s(g,"state",r(null),i),e(g,"stateLength",null),e(g,"byteLength",null)):(n(g,"seed",w),n(g,"seedLength",L),s(g,"state",P,R),n(g,"stateLength",G),n(g,"byteLength",N)),e(g,"PRNG",v.PRNG),g;function b(e,n){var s,r,i,d;if(!t(e))throw new TypeError(p("invalid argument. First argument must be a nonnegative integer. Value: `%s`.",e));if(d={},arguments.length>1&&(r=c(d,n)))throw r;return"generic"===(i=d.dtype||h.dtype)?l(e,v):(s=new(o(i))(e),m([s],[e],[1],v),s)}function x(e,n,s,r){var i,d,m,f;if(!t(e))throw new TypeError(p("invalid argument. First argument must be a nonnegative integer. Value: `%s`.",e));if(f={},arguments.length>3&&(d=c(f,r)))throw d;return"generic"===(m=f.dtype||h.dtype)?l(e,u):(i=new(o(m))(e),a([[n],[s],i],[e],[0,0,1],v),i);function u(){return v(n,s)}}function w(){return g.PRNG.seed}function L(){return g.PRNG.seedLength}function G(){return g.PRNG.stateLength}function N(){return g.PRNG.byteLength}function P(){return g.PRNG.state}function R(e){g.PRNG.state=e}}g.push("generic");var y=v();e(y,"factory",v);export{y as default,v as factory}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index b4fe4ef..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/factory.js","../lib/main.js","../lib/index.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 dtypes from '@stdlib/array-typed-real-float-dtypes';\nimport isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport format from '@stdlib/string-format';\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes();\nDTYPES.push( 'generic' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( DTYPES.indexOf( opts.dtype ) < 0 ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be one of the following: \"%s\". Option: `%s`.', 'dtype', DTYPES.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport setReadOnlyAccessor from '@stdlib/utils-define-nonenumerable-read-only-accessor';\nimport setReadWriteAccessor from '@stdlib/utils-define-nonenumerable-read-write-accessor';\nimport constantFunction from '@stdlib/utils-constant-function';\nimport noop from '@stdlib/utils-noop';\nimport base from '@stdlib/random-base-uniform';\nimport ctors from '@stdlib/array-typed-real-float-ctors';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport nullary from '@stdlib/strided-base-nullary';\nimport binary from '@stdlib/strided-base-binary';\nimport format from '@stdlib/string-format';\nimport defaults from './defaults.json';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution.\n*\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\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 {RangeError} `a` must be less than `b`\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 uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10 );\n* // returns \n*\n* @example\n* var uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nfunction factory() {\n\tvar options;\n\tvar nargs;\n\tvar opts;\n\tvar rand;\n\tvar prng;\n\tvar err;\n\n\topts = {\n\t\t'dtype': defaults.dtype\n\t};\n\n\tnargs = arguments.length;\n\tif ( nargs === 0 ) {\n\t\tprng = base;\n\t\trand = uniform2;\n\t} else if ( nargs === 1 ) {\n\t\toptions = arguments[ 0 ];\n\t\tprng = base.factory( options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform2;\n\t} else if ( nargs === 2 ) {\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ] );\n\t\trand = uniform1;\n\t} else if ( nargs === 3 ) {\n\t\toptions = arguments[ 2 ];\n\t\tprng = base.factory( arguments[ 0 ], arguments[ 1 ], options );\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t\trand = uniform1;\n\t}\n\tif ( options && options.prng ) {\n\t\tsetReadOnly( rand, 'seed', null );\n\t\tsetReadOnly( rand, 'seedLength', null );\n\t\tsetReadWriteAccessor( rand, 'state', constantFunction( null ), noop );\n\t\tsetReadOnly( rand, 'stateLength', null );\n\t\tsetReadOnly( rand, 'byteLength', null );\n\t} else {\n\t\tsetReadOnlyAccessor( rand, 'seed', getSeed );\n\t\tsetReadOnlyAccessor( rand, 'seedLength', getSeedLength );\n\t\tsetReadWriteAccessor( rand, 'state', getState, setState );\n\t\tsetReadOnlyAccessor( rand, 'stateLength', getStateLength );\n\t\tsetReadOnlyAccessor( rand, 'byteLength', getStateSize );\n\t}\n\tsetReadOnly( rand, 'PRNG', prng.PRNG );\n\treturn rand;\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform1( len, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 1 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, prng );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tnullary( [ out ], [ len ], [ 1 ], prng );\n\t\treturn out;\n\t}\n\n\t/**\n\t* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution with minimum support `a` and maximum support `b`.\n\t*\n\t* @private\n\t* @param {NonNegativeInteger} len - array length\n\t* @param {number} a - minimum support\n\t* @param {number} b - maximum support\n\t* @param {Options} [options] - function options\n\t* @param {string} [options.dtype] - output array data type\n\t* @throws {TypeError} first argument must be a nonnegative integer\n\t* @throws {TypeError} options argument must be an object\n\t* @throws {TypeError} must provide valid options\n\t* @returns {(Array|TypedArray)} output array\n\t*/\n\tfunction uniform2( len, a, b, options ) {\n\t\tvar ctor;\n\t\tvar out;\n\t\tvar err;\n\t\tvar dt;\n\t\tvar o;\n\t\tif ( !isNonNegativeInteger( len ) ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) );\n\t\t}\n\t\to = {};\n\t\tif ( arguments.length > 3 ) {\n\t\t\terr = validate( o, options );\n\t\t\tif ( err ) {\n\t\t\t\tthrow err;\n\t\t\t}\n\t\t}\n\t\t// NOTE: we could alternatively use the PRNG factory function to create a PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. Decision made here to avoid this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom number. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in a return value of `NaN`.\n\t\tdt = o.dtype || opts.dtype;\n\t\tif ( dt === 'generic' ) {\n\t\t\treturn filledBy( len, wrapper );\n\t\t}\n\t\tctor = ctors( dt );\n\t\tout = new ctor( len );\n\t\tbinary( [ [ a ], [ b ], out ], [ len ], [ 0, 0, 1 ], prng );\n\t\treturn out;\n\n\t\t/**\n\t\t* Applies parameters to a pseudorandom number generator function.\n\t\t*\n\t\t* @private\n\t\t* @returns {number} pseudorandom number\n\t\t*/\n\t\tfunction wrapper() {\n\t\t\treturn prng( a, b );\n\t\t}\n\t}\n\n\t/**\n\t* Returns the PRNG seed.\n\t*\n\t* @private\n\t* @returns {PRNGSeedMT19937} seed\n\t*/\n\tfunction getSeed() {\n\t\treturn rand.PRNG.seed;\n\t}\n\n\t/**\n\t* Returns the PRNG seed length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} seed length\n\t*/\n\tfunction getSeedLength() {\n\t\treturn rand.PRNG.seedLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state length.\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state length\n\t*/\n\tfunction getStateLength() {\n\t\treturn rand.PRNG.stateLength;\n\t}\n\n\t/**\n\t* Returns the PRNG state size (in bytes).\n\t*\n\t* @private\n\t* @returns {PositiveInteger} state size (in bytes)\n\t*/\n\tfunction getStateSize() {\n\t\treturn rand.PRNG.byteLength;\n\t}\n\n\t/**\n\t* Returns the current pseudorandom number generator state.\n\t*\n\t* @private\n\t* @returns {PRNGStateMT19937} current state\n\t*/\n\tfunction getState() {\n\t\treturn rand.PRNG.state;\n\t}\n\n\t/**\n\t* Sets the pseudorandom number generator state.\n\t*\n\t* @private\n\t* @param {PRNGStateMT19937} s - generator state\n\t* @throws {Error} must provide a valid state\n\t*/\n\tfunction setState( s ) {\n\t\trand.PRNG.state = s;\n\t}\n}\n\n\n// EXPORTS //\n\nexport default factory;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @name uniform\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\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 = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar uniform = factory();\n\n\n// EXPORTS //\n\nexport default uniform;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @module @stdlib/random-array-uniform\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.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\" }\n"],"names":["DTYPES","dtypes","validate","opts","options","isObject","hasOwnProp","dtype","indexOf","TypeError","format","join","factory","nargs","rand","prng","err","defaults","arguments","length","base","uniform2","uniform1","setReadOnly","setReadWriteAccessor","constantFunction","noop","setReadOnlyAccessor","getSeed","getSeedLength","getState","setState","getStateLength","getStateSize","PRNG","len","out","dt","o","isNonNegativeInteger","filledBy","ctors","nullary","a","b","wrapper","binary","seed","seedLength","stateLength","byteLength","state","s","push","uniform","main"],"mappings":";;2gDA8BIA,EAASC,IAyBb,SAASC,EAAUC,EAAMC,GACxB,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,WACzBD,EAAKI,MAAQH,EAAQG,MAChBP,EAAOQ,QAASL,EAAKI,OAAU,GAC5B,IAAIE,UAAWC,EAAQ,gFAAiF,QAASV,EAAOW,KAAM,QAAUR,EAAKI,QAG/I,KARC,IAAIE,UAAWC,EAAQ,qEAAsEN,GAStG,CCSA,SAASQ,IACR,IAAIR,EACAS,EACAV,EACAW,EACAC,EACAC,EAOJ,GALAb,EAAO,CACNI,MAASU,GAIK,KADfJ,EAAQK,UAAUC,QAEjBJ,EAAOK,EACPN,EAAOO,OACD,GAAe,IAAVR,EAAc,CAIzB,GAHAT,EAAUc,UAAW,GACrBH,EAAOK,EAAKR,QAASR,GACrBY,EAAMd,EAAUC,EAAMC,GAErB,MAAMY,EAEPF,EAAOO,CACT,MAAQ,GAAe,IAAVR,EACXE,EAAOK,EAAKR,QAASM,UAAW,GAAKA,UAAW,IAChDJ,EAAOQ,OACD,GAAe,IAAVT,EAAc,CAIzB,GAHAT,EAAUc,UAAW,GACrBH,EAAOK,EAAKR,QAASM,UAAW,GAAKA,UAAW,GAAKd,GACrDY,EAAMd,EAAUC,EAAMC,GAErB,MAAMY,EAEPF,EAAOQ,CACP,CAeD,OAdKlB,GAAWA,EAAQW,MACvBQ,EAAaT,EAAM,OAAQ,MAC3BS,EAAaT,EAAM,aAAc,MACjCU,EAAsBV,EAAM,QAASW,EAAkB,MAAQC,GAC/DH,EAAaT,EAAM,cAAe,MAClCS,EAAaT,EAAM,aAAc,QAEjCa,EAAqBb,EAAM,OAAQc,GACnCD,EAAqBb,EAAM,aAAce,GACzCL,EAAsBV,EAAM,QAASgB,EAAUC,GAC/CJ,EAAqBb,EAAM,cAAekB,GAC1CL,EAAqBb,EAAM,aAAcmB,IAE1CV,EAAaT,EAAM,OAAQC,EAAKmB,MACzBpB,EAcP,SAASQ,EAAUa,EAAK/B,GACvB,IACIgC,EACApB,EACAqB,EACAC,EACJ,IAAMC,EAAsBJ,GAC3B,MAAM,IAAI1B,UAAWC,EAAQ,+EAAgFyB,IAG9G,GADAG,EAAI,CAAA,EACCpB,UAAUC,OAAS,IACvBH,EAAMd,EAAUoC,EAAGlC,IAElB,MAAMY,EAIR,MAAY,aADZqB,EAAKC,EAAE/B,OAASJ,EAAKI,OAEbiC,EAAUL,EAAKpB,IAGvBqB,EAAM,IADCK,EAAOJ,GACR,CAAUF,GAChBO,EAAS,CAAEN,GAAO,CAAED,GAAO,CAAE,GAAKpB,GAC3BqB,EACP,CAgBD,SAASf,EAAUc,EAAKQ,EAAGC,EAAGxC,GAC7B,IACIgC,EACApB,EACAqB,EACAC,EACJ,IAAMC,EAAsBJ,GAC3B,MAAM,IAAI1B,UAAWC,EAAQ,+EAAgFyB,IAG9G,GADAG,EAAI,CAAA,EACCpB,UAAUC,OAAS,IACvBH,EAAMd,EAAUoC,EAAGlC,IAElB,MAAMY,EAKR,MAAY,aADZqB,EAAKC,EAAE/B,OAASJ,EAAKI,OAEbiC,EAAUL,EAAKU,IAGvBT,EAAM,IADCK,EAAOJ,GACR,CAAUF,GAChBW,EAAQ,CAAE,CAAEH,GAAK,CAAEC,GAAKR,GAAO,CAAED,GAAO,CAAE,EAAG,EAAG,GAAKpB,GAC9CqB,GAQP,SAASS,IACR,OAAO9B,EAAM4B,EAAGC,EAChB,CACD,CAQD,SAAShB,IACR,OAAOd,EAAKoB,KAAKa,IACjB,CAQD,SAASlB,IACR,OAAOf,EAAKoB,KAAKc,UACjB,CAQD,SAAShB,IACR,OAAOlB,EAAKoB,KAAKe,WACjB,CAQD,SAAShB,IACR,OAAOnB,EAAKoB,KAAKgB,UACjB,CAQD,SAASpB,IACR,OAAOhB,EAAKoB,KAAKiB,KACjB,CASD,SAASpB,EAAUqB,GAClBtC,EAAKoB,KAAKiB,MAAQC,CAClB,CACF,CDrPApD,EAAOqD,KAAM,WEqBV,IAACC,EAAU1C,ICiBdW,EAAAgC,EAAA,UAAA3C"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index bd80a2c..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From d099c90a8ec1034d6f05b23d4da22e7148def8bd Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 10 Jan 2024 04:28:37 +0000 Subject: [PATCH 54/82] 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 | 198 - docs/types/test.ts | 409 -- examples/index.js | 48 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/factory.js | 77 - lib/index.js | 77 - lib/main.js | 58 - package.json | 71 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 118 - test/test.factory.js | 1261 ----- test/test.js | 74 - test/test.main.js | 244 - 54 files changed, 6217 insertions(+), 6809 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 c4ab52b..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/uniform) 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 5097056..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/uniform) 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 7f3bcd6..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: '33 9 * * 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 + + ```
@@ -398,7 +397,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]. @@ -458,13 +457,13 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/random-array-uniform/main/LICENSE -[@stdlib/random/base/uniform]: https://github.com/stdlib-js/random-base-uniform +[@stdlib/random/base/uniform]: https://github.com/stdlib-js/random-base-uniform/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 4923816..0000000 --- a/benchmark/benchmark.float32.assign.js +++ /dev/null @@ -1,97 +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 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, 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 dea0644..0000000 --- a/benchmark/benchmark.float32.factory.js +++ /dev/null @@ -1,96 +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 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, { - '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 4249752..0000000 --- a/benchmark/benchmark.float32.js +++ /dev/null @@ -1,98 +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 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, 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 8cf1538..0000000 --- a/benchmark/benchmark.float64.assign.js +++ /dev/null @@ -1,97 +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 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, 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 f352bca..0000000 --- a/benchmark/benchmark.float64.factory.js +++ /dev/null @@ -1,96 +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 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, { - '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 e176e0a..0000000 --- a/benchmark/benchmark.float64.js +++ /dev/null @@ -1,98 +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 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, 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 6038ee7..0000000 --- a/benchmark/benchmark.generic.assign.js +++ /dev/null @@ -1,97 +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 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, 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 6a6bddc..0000000 --- a/benchmark/benchmark.generic.factory.js +++ /dev/null @@ -1,96 +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 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, { - '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 b6bdcfd..0000000 --- a/benchmark/benchmark.generic.js +++ /dev/null @@ -1,98 +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 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, 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 30542fb..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/uniform" -%% click B href "https://github.com/stdlib-js/random-array-uniform/tree/main" -%% click C href "https://github.com/stdlib-js/random-array-uniform/tree/production" -%% click D href "https://github.com/stdlib-js/random-array-uniform/tree/esm" -%% click E href "https://github.com/stdlib-js/random-array-uniform/tree/deno" -%% click F href "https://github.com/stdlib-js/random-array-uniform/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/uniform -[production-url]: https://github.com/stdlib-js/random-array-uniform/tree/production -[deno-url]: https://github.com/stdlib-js/random-array-uniform/tree/deno -[umd-url]: https://github.com/stdlib-js/random-array-uniform/tree/umd -[esm-url]: https://github.com/stdlib-js/random-array-uniform/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 f2a679f..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import uniform from '../docs/types/index'; -export = uniform; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index f49a668..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var a=function(u,r){return function(){return r||u((r={exports:{}}).exports,r),r.exports}};var e=a(function(x,t){ -var v=require('@stdlib/random-array-tools-binary-factory/dist'),n=require('@stdlib/array-dtypes/dist'),c=require('@stdlib/array-defaults/dist'),y=require('@stdlib/random-base-uniform/dist'),f=n("real_floating_point_and_generic"),q=v(y,f,c.get("dtypes.real_floating_point"));t.exports=q -});var s=a(function(b,i){ -var p=e(),l=p();i.exports=l -});var _=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),o=s(),d=e();_(o,"factory",d);module.exports=o; -/** @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 815b1ac..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) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 binaryFactory = require( '@stdlib/random-array-tools-binary-factory' );\nvar dtypes = require( '@stdlib/array-dtypes' );\nvar defaults = require( '@stdlib/array-defaults' );\nvar base = require( '@stdlib/random-base-uniform' );\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 continuous uniform distribution.\n*\n* @name factory\n* @type {Function}\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\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} 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 uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10 );\n* // returns \n*\n* @example\n* var uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar factory = binaryFactory( 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) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution.\n*\n* @name uniform\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\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 = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar uniform = factory();\n\n\n// EXPORTS //\n\nmodule.exports = uniform;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution.\n*\n* @module @stdlib/random-array-uniform\n*\n* @example\n* var uniform = require( '@stdlib/random-array-uniform' );\n*\n* var arr = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var uniform = require( '@stdlib/random-array-uniform' );\n*\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* var uniform = require( '@stdlib/random-array-uniform' );\n*\n* var rand = uniform.factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* var uniform = require( '@stdlib/random-array-uniform' );\n*\n* var rand = uniform.factory( 2.0, 5.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,EAAgB,QAAS,2CAA4C,EACrEC,EAAS,QAAS,sBAAuB,EACzCC,EAAW,QAAS,wBAAyB,EAC7CC,EAAO,QAAS,6BAA8B,EAK9CC,EAASH,EAAQ,iCAAkC,EAyCnDI,EAAUL,EAAeG,EAAMC,EAAQF,EAAS,IAAK,4BAA6B,CAAE,EAKxFH,EAAO,QAAUM,IC5EjB,IAAAC,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,IA8BVC,EAAUD,EAAQ,EAKtBD,EAAO,QAAUE,ICKjB,IAAIC,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAU,IAKdF,EAAaC,EAAM,UAAWC,CAAQ,EAKtC,OAAO,QAAUD", - "names": ["require_factory", "__commonJSMin", "exports", "module", "binaryFactory", "dtypes", "defaults", "base", "DTYPES", "factory", "require_main", "__commonJSMin", "exports", "module", "factory", "uniform", "setReadOnly", "main", "factory"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index af6976c..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,198 +0,0 @@ - -{{alias}}( len, a, b[, options] ) - Returns an array containing pseudorandom numbers drawn from a continuous - uniform distribution. - - Parameters - ---------- - len: integer - Output array length. - - a: number - Minimum support. - - b: number - Maximum support. - - 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 ) - - - -{{alias}}.assign( a, b, out ) - Fills an array with pseudorandom numbers drawn from a continuous uniform - distribution. - - Parameters - ---------- - a: number - Minimum support. - - b: number - Maximum support. - - 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, x ) - - > var bool = ( out === x ) - true - - -{{alias}}.factory( [a, b, ][options] ) - Returns a function for creating arrays containing pseudorandom numbers drawn - from a continuous uniform 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. - - 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 ) - - - // Provide distribution parameters: - > fcn = {{alias}}.factory( 2.0, 5.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 ) - - - // Get a copy of the current state: - > var state = {{alias}}.state - - - > out = {{alias}}( 3, 2.0, 5.0 ) - - > out = {{alias}}( 3, 2.0, 5.0 ) - - - // Set the state: - > {{alias}}.state = state; - - // Regenerate a previous array: - > out = {{alias}}( 3, 2.0, 5.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 9e8939e..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,409 +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. -*/ - -import zeros = require( '@stdlib/array-zeros' ); -import random = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - random( 10, 2.0, 5.0 ); // $ExpectType RandomArray - random( 10, 2.0, 5.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 ); // $ExpectError - random( true, 2.0, 5.0 ); // $ExpectError - random( false, 2.0, 5.0 ); // $ExpectError - random( null, 2.0, 5.0 ); // $ExpectError - random( [], 2.0, 5.0 ); // $ExpectError - random( {}, 2.0, 5.0 ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - random( '5', 2.0, 5.0, {} ); // $ExpectError - random( true, 2.0, 5.0, {} ); // $ExpectError - random( false, 2.0, 5.0, {} ); // $ExpectError - random( null, 2.0, 5.0, {} ); // $ExpectError - random( [], 2.0, 5.0, {} ); // $ExpectError - random( {}, 2.0, 5.0, {} ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.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 ); // $ExpectError - random( 10, true, 5.0 ); // $ExpectError - random( 10, false, 5.0 ); // $ExpectError - random( 10, null, 5.0 ); // $ExpectError - random( 10, [], 5.0 ); // $ExpectError - random( 10, {}, 5.0 ); // $ExpectError - random( 10, ( x: number ): number => x, 5.0 ); // $ExpectError - - random( 10, '5', 5.0, {} ); // $ExpectError - random( 10, true, 5.0, {} ); // $ExpectError - random( 10, false, 5.0, {} ); // $ExpectError - random( 10, null, 5.0, {} ); // $ExpectError - random( 10, [], 5.0, {} ); // $ExpectError - random( 10, {}, 5.0, {} ); // $ExpectError - random( 10, ( x: number ): number => x, 5.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' ); // $ExpectError - random( 10, 2.0, true ); // $ExpectError - random( 10, 2.0, false ); // $ExpectError - random( 10, 2.0, null ); // $ExpectError - random( 10, 2.0, [] ); // $ExpectError - random( 10, 2.0, {} ); // $ExpectError - random( 10, 2.0, ( x: number ): number => x ); // $ExpectError - - random( 10, 2.0, '5', {} ); // $ExpectError - random( 10, 2.0, true, {} ); // $ExpectError - random( 10, 2.0, false, {} ); // $ExpectError - random( 10, 2.0, null, {} ); // $ExpectError - random( 10, 2.0, [], {} ); // $ExpectError - random( 10, 2.0, {}, {} ); // $ExpectError - random( 10, 2.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, '5' ); // $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, [] ); // $ExpectError - random( 10, 2.0, 5.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, { 'dtype': 123 } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': null } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - random( 10, 2.0, 5.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 -} - -// Attached to the main export is an `assign` method which returns an array... -{ - const x = zeros( 10, 'float64' ); - - random.assign( 2.0, 5.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, x ); // $ExpectError - random.assign( true, 5.0, x ); // $ExpectError - random.assign( false, 5.0, x ); // $ExpectError - random.assign( null, 5.0, x ); // $ExpectError - random.assign( [], 5.0, x ); // $ExpectError - random.assign( {}, 5.0, x ); // $ExpectError - random.assign( ( x: number ): number => x, 5.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', x ); // $ExpectError - random.assign( 2.0, true, x ); // $ExpectError - random.assign( 2.0, false, x ); // $ExpectError - random.assign( 2.0, null, x ); // $ExpectError - random.assign( 2.0, [], x ); // $ExpectError - random.assign( 2.0, {}, x ); // $ExpectError - random.assign( 2.0, ( x: number ): number => x, x ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid output array... -{ - random.assign( 2.0, 5.0, '5' ); // $ExpectError - random.assign( 2.0, 5.0, 5 ); // $ExpectError - random.assign( 2.0, 5.0, true ); // $ExpectError - random.assign( 2.0, 5.0, false ); // $ExpectError - random.assign( 2.0, 5.0, null ); // $ExpectError - random.assign( 2.0, 5.0, {} ); // $ExpectError - random.assign( 2.0, 5.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const 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 -} - -// Attached to main export is a `factory` method which returns a function... -{ - random.factory( 2.0, 5.0 ); // $ExpectType UnaryFunction - random.factory( 2.0, 5.0, { 'copy': false } ); // $ExpectType UnaryFunction - - random.factory(); // $ExpectType TernaryFunction - random.factory( { 'copy': false } ); // $ExpectType TernaryFunction -} - -// The `factory` method returns a function which returns an array... -{ - const fcn1 = random.factory( 2.0, 5.0 ); - fcn1( 10 ); // $ExpectType RandomArray - - const fcn2 = random.factory(); - fcn2( 10, 2.0, 5.0 ); // $ExpectType RandomArray -} - -// The compiler throws an error if the `factory` method is provided invalid arguments... -{ - random.factory( '5', 5.0 ); // $ExpectError - random.factory( true, 5.0 ); // $ExpectError - random.factory( false, 5.0 ); // $ExpectError - random.factory( [], 5.0 ); // $ExpectError - random.factory( {}, 5.0 ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0 ); // $ExpectError - - random.factory( '5', 5.0, {} ); // $ExpectError - random.factory( true, 5.0, {} ); // $ExpectError - random.factory( false, 5.0, {} ); // $ExpectError - random.factory( [], 5.0, {} ); // $ExpectError - random.factory( {}, 5.0, {} ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0, {} ); // $ExpectError - - random.factory( 2.0, '5' ); // $ExpectError - random.factory( 2.0, true ); // $ExpectError - random.factory( 2.0, false ); // $ExpectError - random.factory( 2.0, [] ); // $ExpectError - random.factory( 2.0, {} ); // $ExpectError - random.factory( 2.0, ( x: number ): number => x ); // $ExpectError - - random.factory( 2.0, '5', {} ); // $ExpectError - random.factory( 2.0, true, {} ); // $ExpectError - random.factory( 2.0, false, {} ); // $ExpectError - random.factory( 2.0, [], {} ); // $ExpectError - random.factory( 2.0, {}, {} ); // $ExpectError - random.factory( 2.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, 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, { 'prng': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'seed': true } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': [ 'a' ] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'state': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': {} } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': true } ); // $ExpectError - random.factory( 2.0, 5.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, { 'copy': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'dtype': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - random.factory( 2.0, 5.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, {}, {} ); // $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 ); - 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 ); // $ExpectError - fcn2( false, 2.0, 5.0 ); // $ExpectError - fcn2( '5', 2.0, 5.0 ); // $ExpectError - fcn2( [], 2.0, 5.0 ); // $ExpectError - fcn2( {}, 2.0, 5.0 ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - fcn2( true, 2.0, 5.0, {} ); // $ExpectError - fcn2( false, 2.0, 5.0, {} ); // $ExpectError - fcn2( '5', 2.0, 5.0, {} ); // $ExpectError - fcn2( [], 2.0, 5.0, {} ); // $ExpectError - fcn2( {}, 2.0, 5.0, {} ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0, {} ); // $ExpectError - - fcn2( 10, true, 5.0 ); // $ExpectError - fcn2( 10, false, 5.0 ); // $ExpectError - fcn2( 10, '5', 5.0 ); // $ExpectError - fcn2( 10, [], 5.0 ); // $ExpectError - fcn2( 10, {}, 5.0 ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0 ); // $ExpectError - - fcn2( 10, true, 5.0, {} ); // $ExpectError - fcn2( 10, false, 5.0, {} ); // $ExpectError - fcn2( 10, '5', 5.0, {} ); // $ExpectError - fcn2( 10, [], 5.0, {} ); // $ExpectError - fcn2( 10, {}, 5.0, {} ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0, {} ); // $ExpectError - - fcn2( 10, 2.0, true ); // $ExpectError - fcn2( 10, 2.0, false ); // $ExpectError - fcn2( 10, 2.0, '5' ); // $ExpectError - fcn2( 10, 2.0, [] ); // $ExpectError - fcn2( 10, 2.0, {} ); // $ExpectError - fcn2( 10, 2.0, ( x: number ): number => x ); // $ExpectError - - fcn2( 10, 2.0, true, {} ); // $ExpectError - fcn2( 10, 2.0, false, {} ); // $ExpectError - fcn2( 10, 2.0, '5', {} ); // $ExpectError - fcn2( 10, 2.0, [], {} ); // $ExpectError - fcn2( 10, 2.0, {}, {} ); // $ExpectError - fcn2( 10, 2.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, { 'dtype': 123 } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': null } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError - - const fcn2 = random.factory( 2.0, 5.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 ); - fcn1(); // $ExpectError - fcn1( 1, 1, 1 ); // $ExpectError - - const fcn2 = random.factory(); - fcn2(); // $ExpectError - fcn2( 1 ); // $ExpectError - fcn2( 1, 1, 1, 1 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index c485546..0000000 --- a/examples/index.js +++ /dev/null @@ -1,48 +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'; - -var logEach = require( '@stdlib/console-log-each' ); -var uniform = require( './../lib' ); - -// Create a function for generating random arrays originating from the same state: -var random = uniform.factory( 2.0, 5.0, { - 'state': uniform.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 = uniform.factory( 2.0, 5.0, { - 'state': uniform.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 9a727e8..2935269 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..883e5f3 --- /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-binary-factory@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtypes@v0.1.0-esm/index.mjs";import r 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-uniform@v0.1.0-esm/index.mjs";var d=e(n,s("real_floating_point_and_generic"),r.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..4e9834a --- /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) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 binaryFactory from '@stdlib/random-array-tools-binary-factory';\nimport dtypes from '@stdlib/array-dtypes';\nimport defaults from '@stdlib/array-defaults';\nimport base from '@stdlib/random-base-uniform';\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 continuous uniform distribution.\n*\n* @name factory\n* @type {Function}\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\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} 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 uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10 );\n* // returns \n*\n* @example\n* var uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar factory = binaryFactory( 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) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution.\n*\n* @name uniform\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\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 = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar uniform = factory();\n\n\n// EXPORTS //\n\nexport default uniform;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution.\n*\n* @module @stdlib/random-array-uniform\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.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","binaryFactory","base","dtypes","defaults","get","uniform","setReadOnly","main"],"mappings":";;2eA8BA,IAyCIA,EAAUC,EAAeC,EAzChBC,EAAQ,mCAyCsBC,EAASC,IAAK,+BCnBrDC,EAAUN,ICiBdO,EAAAC,EAAA,UAAAR"} \ No newline at end of file diff --git a/lib/factory.js b/lib/factory.js deleted file mode 100644 index 79da171..0000000 --- a/lib/factory.js +++ /dev/null @@ -1,77 +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 binaryFactory = require( '@stdlib/random-array-tools-binary-factory' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var defaults = require( '@stdlib/array-defaults' ); -var base = require( '@stdlib/random-base-uniform' ); - - -// VARIABLES // - -var DTYPES = dtypes( 'real_floating_point_and_generic' ); - - -// MAIN // - -/** -* Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution. -* -* @name factory -* @type {Function} -* @param {number} [a] - minimum support -* @param {number} [b] - maximum support -* @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} 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 uniform = factory( 2.0, 5.0 ); -* // returns -* -* var arr = uniform( 10 ); -* // returns -* -* @example -* var uniform = factory( 2.0, 5.0 ); -* // returns -* -* var arr = uniform( 10, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -var factory = binaryFactory( 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 3376c12..0000000 --- a/lib/index.js +++ /dev/null @@ -1,77 +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'; - -/** -* Create an array containing pseudorandom numbers drawn from a continuous uniform distribution. -* -* @module @stdlib/random-array-uniform -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var arr = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var arr = uniform( 10, 2.0, 5.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var rand = uniform.factory( 2.0, 5.0 ); -* // returns -* -* var arr = rand( 10 ); -* // returns -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var rand = uniform.factory( 2.0, 5.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 f93ef8f..0000000 --- a/lib/main.js +++ /dev/null @@ -1,58 +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 factory = require( './factory.js' ); - - -// MAIN // - -/** -* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution. -* -* @name uniform -* @type {Function} -* @param {NonNegativeInteger} len - array length -* @param {number} a - minimum support -* @param {number} b - maximum support -* @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 = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var arr = uniform( 10, 2.0, 5.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -var uniform = factory(); - - -// EXPORTS // - -module.exports = uniform; diff --git a/package.json b/package.json index f38f80e..767a213 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 continuous uniform 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-binary-factory": "^0.1.0", - "@stdlib/random-base-uniform": "^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..015e087 --- /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 14d34c7..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, 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, 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, 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, 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 765abb1..0000000 --- a/test/test.factory.js +++ /dev/null @@ -1,1261 +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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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, 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, { - '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, { - '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, { - '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, { - '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, { - '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, { - '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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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 ); - - 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 ); - - 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, { - '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 ); - - 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 ); - 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 ); - - 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 ); - - 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 ); - - 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 ); - - 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, { - '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 ); - - 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, { - '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 ); - - 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, { - '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 ); - - 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, { - '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 ); - - 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, { - '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, { - '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 ); - - // 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, { - '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 ); - - // 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, { - '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 ); - - 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, { - 'prng': randu.normalized - }); - - randu = minstd.factory({ - 'seed': seed - }); - random2 = factory( 2.0, 5.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 ); - arr2 = random2( 10, 2.0, 5.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 4e0f74d..0000000 --- a/test/test.js +++ /dev/null @@ -1,74 +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 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 faf9d84..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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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, 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, { - '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 ); - - 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, { - '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, { - '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, { - '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 ); - } - // Capture the current state: - state = random.state; - - // Move to a future state... - arr = random( 10, 2.0, 5.0 ); - for ( i = 0; i < 100; i++ ) { - random( 2, 2.0, 5.0 ); - } - // Set the state: - random.state = state; - - // Replay previously generated values: - t.deepEqual( random( 10, 2.0, 5.0 ), arr, 'returns expected value' ); - - t.end(); -}); From 9d6959742450813f8206db68cf1d17e207581466 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 10 Jan 2024 10:26:47 +0000 Subject: [PATCH 55/82] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index d90549b..f38f80e 100644 --- a/package.json +++ b/package.json @@ -42,7 +42,8 @@ "@stdlib/random-array-tools-binary-factory": "^0.1.0", "@stdlib/random-base-uniform": "^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 97ed7ee6791f82fcb8e644448547f35d560a1d5e Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 10 Jan 2024 10:34:52 +0000 Subject: [PATCH 56/82] Remove files --- index.d.ts | 279 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6461 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 2935269..0000000 --- a/index.d.ts +++ /dev/null @@ -1,279 +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. -*/ - -// 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 continuous uniform distribution with pre-specified parameter values. -*/ -interface UnaryFunction extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform 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 continuous uniform distribution. - * - * @param out - output array - * @returns output array - */ - assign( out: RandomArray ): RandomArray; -} - -/** -* Interface for generating pseudorandom numbers drawn from a continuous uniform distribution without pre-specified parameter values. -*/ -interface TernaryFunction extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution. - * - * @param len - array length - * @param a - minimum support - * @param b - maximum support - * @param options - function options - * @returns output array - */ - ( len: number, a: number, b: number, options?: Options ): RandomArray; - - /** - * Fills an array with pseudorandom numbers drawn from a continuous uniform distribution. - * - * @param a - minimum support - * @param b - maximum support - * @param out - output array - * @returns output array - */ - assign( a: number, b: number, out: RandomArray ): RandomArray; -} - -/** -* Interface for generating pseudorandom numbers drawn from a continuous uniform distribution. -*/ -interface Random extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution. - * - * @param len - array length - * @param a - minimum support - * @param b - maximum support - * @param options - function options - * @returns output array - * - * @example - * var out = uniform( 10, 2.0, 5.0 ); - * // returns - */ - ( len: number, a: number, b: number, options?: Options ): RandomArray; - - /** - * Fills an array with pseudorandom numbers drawn from a continuous uniform distribution. - * - * @param a - minimum support - * @param b - maximum support - * @param out - output array - * @returns output array - * - * @example - * var zeros = require( '@stdlib/array-zeros' ); - * - * var x = zeros( 10, 'float64' ); - * // returns - * - * var out = uniform( 2.0, 5.0, out ); - * // returns - * - * var bool = ( out === x ); - * // returns true - */ - assign( a: number, b: number, out: RandomArray ): RandomArray; - - /** - * Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform 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 options - function options - * @throws must provide a valid state - * @returns function for creating arrays - * - * @example - * var random = uniform.factory( 2.0, 5.0 ); - * - * var out = random( 10 ); - * // returns - * - * @example - * var random = uniform.factory( 2.0, 5.0, { - * 'seed': 297 - * }); - * var out = random( 10 ); - * // returns - */ - factory( a: number, b: number, options?: FactoryOptions ): UnaryFunction; - - /** - * Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform 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 = uniform.factory(); - * - * var out = random( 10, 2.0, 5.0 ); - * // returns - * - * @example - * var random = uniform.factory({ - * 'seed': 297 - * }); - * var out = random( 10, 2.0, 5.0 ); - * // returns - */ - factory( options?: FactoryOptions ): TernaryFunction; -} - -/** -* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution. -* -* @param len - array length -* @param a - minimum support -* @param b - maximum support -* @param options - function options -* @returns output array -* -* @example -* var out = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var random = uniform.factory( 2.0, 5.0 ); -* -* var out = random( 10 ); -* // returns -*/ -declare var uniform: Random; - - -// EXPORTS // - -export = uniform; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 883e5f3..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-binary-factory@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtypes@v0.1.0-esm/index.mjs";import r 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-uniform@v0.1.0-esm/index.mjs";var d=e(n,s("real_floating_point_and_generic"),r.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 4e9834a..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) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 binaryFactory from '@stdlib/random-array-tools-binary-factory';\nimport dtypes from '@stdlib/array-dtypes';\nimport defaults from '@stdlib/array-defaults';\nimport base from '@stdlib/random-base-uniform';\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 continuous uniform distribution.\n*\n* @name factory\n* @type {Function}\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\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} 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 uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10 );\n* // returns \n*\n* @example\n* var uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar factory = binaryFactory( 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) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution.\n*\n* @name uniform\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\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 = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar uniform = factory();\n\n\n// EXPORTS //\n\nexport default uniform;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution.\n*\n* @module @stdlib/random-array-uniform\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.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","binaryFactory","base","dtypes","defaults","get","uniform","setReadOnly","main"],"mappings":";;2eA8BA,IAyCIA,EAAUC,EAAeC,EAzChBC,EAAQ,mCAyCsBC,EAASC,IAAK,+BCnBrDC,EAAUN,ICiBdO,EAAAC,EAAA,UAAAR"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 015e087..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 242874a7dae72e7eaaeb46c362b97a06a7f0818a Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 10 Jan 2024 10:35:18 +0000 Subject: [PATCH 57/82] 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 | 67 +- 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 | 198 - docs/types/test.ts | 409 -- examples/index.js | 48 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/factory.js | 77 - lib/index.js | 77 - lib/main.js | 58 - package.json | 71 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 118 - test/test.factory.js | 1261 ----- test/test.js | 74 - test/test.main.js | 244 - 54 files changed, 6219 insertions(+), 6811 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 c4ab52b..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/uniform) 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 5097056..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/uniform) 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 7f3bcd6..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: '33 9 * * 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,19 +465,19 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/random-array-uniform/main/LICENSE -[@stdlib/random/base/uniform]: https://github.com/stdlib-js/random-base-uniform +[@stdlib/random/base/uniform]: https://github.com/stdlib-js/random-base-uniform/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 -[@stdlib/random/array/discrete-uniform]: https://github.com/stdlib-js/random-array-discrete-uniform +[@stdlib/random/array/discrete-uniform]: https://github.com/stdlib-js/random-array-discrete-uniform/tree/esm -[@stdlib/random/strided/uniform]: https://github.com/stdlib-js/random-strided-uniform +[@stdlib/random/strided/uniform]: https://github.com/stdlib-js/random-strided-uniform/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 4923816..0000000 --- a/benchmark/benchmark.float32.assign.js +++ /dev/null @@ -1,97 +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 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, 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 dea0644..0000000 --- a/benchmark/benchmark.float32.factory.js +++ /dev/null @@ -1,96 +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 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, { - '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 4249752..0000000 --- a/benchmark/benchmark.float32.js +++ /dev/null @@ -1,98 +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 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, 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 8cf1538..0000000 --- a/benchmark/benchmark.float64.assign.js +++ /dev/null @@ -1,97 +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 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, 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 f352bca..0000000 --- a/benchmark/benchmark.float64.factory.js +++ /dev/null @@ -1,96 +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 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, { - '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 e176e0a..0000000 --- a/benchmark/benchmark.float64.js +++ /dev/null @@ -1,98 +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 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, 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 6038ee7..0000000 --- a/benchmark/benchmark.generic.assign.js +++ /dev/null @@ -1,97 +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 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, 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 6a6bddc..0000000 --- a/benchmark/benchmark.generic.factory.js +++ /dev/null @@ -1,96 +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 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, { - '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 b6bdcfd..0000000 --- a/benchmark/benchmark.generic.js +++ /dev/null @@ -1,98 +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 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, 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 30542fb..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/uniform" -%% click B href "https://github.com/stdlib-js/random-array-uniform/tree/main" -%% click C href "https://github.com/stdlib-js/random-array-uniform/tree/production" -%% click D href "https://github.com/stdlib-js/random-array-uniform/tree/esm" -%% click E href "https://github.com/stdlib-js/random-array-uniform/tree/deno" -%% click F href "https://github.com/stdlib-js/random-array-uniform/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/uniform -[production-url]: https://github.com/stdlib-js/random-array-uniform/tree/production -[deno-url]: https://github.com/stdlib-js/random-array-uniform/tree/deno -[umd-url]: https://github.com/stdlib-js/random-array-uniform/tree/umd -[esm-url]: https://github.com/stdlib-js/random-array-uniform/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 f2a679f..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import uniform from '../docs/types/index'; -export = uniform; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index f49a668..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var a=function(u,r){return function(){return r||u((r={exports:{}}).exports,r),r.exports}};var e=a(function(x,t){ -var v=require('@stdlib/random-array-tools-binary-factory/dist'),n=require('@stdlib/array-dtypes/dist'),c=require('@stdlib/array-defaults/dist'),y=require('@stdlib/random-base-uniform/dist'),f=n("real_floating_point_and_generic"),q=v(y,f,c.get("dtypes.real_floating_point"));t.exports=q -});var s=a(function(b,i){ -var p=e(),l=p();i.exports=l -});var _=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),o=s(),d=e();_(o,"factory",d);module.exports=o; -/** @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 815b1ac..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) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 binaryFactory = require( '@stdlib/random-array-tools-binary-factory' );\nvar dtypes = require( '@stdlib/array-dtypes' );\nvar defaults = require( '@stdlib/array-defaults' );\nvar base = require( '@stdlib/random-base-uniform' );\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 continuous uniform distribution.\n*\n* @name factory\n* @type {Function}\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\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} 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 uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10 );\n* // returns \n*\n* @example\n* var uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar factory = binaryFactory( 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) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution.\n*\n* @name uniform\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\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 = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar uniform = factory();\n\n\n// EXPORTS //\n\nmodule.exports = uniform;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution.\n*\n* @module @stdlib/random-array-uniform\n*\n* @example\n* var uniform = require( '@stdlib/random-array-uniform' );\n*\n* var arr = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var uniform = require( '@stdlib/random-array-uniform' );\n*\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* var uniform = require( '@stdlib/random-array-uniform' );\n*\n* var rand = uniform.factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* var uniform = require( '@stdlib/random-array-uniform' );\n*\n* var rand = uniform.factory( 2.0, 5.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,EAAgB,QAAS,2CAA4C,EACrEC,EAAS,QAAS,sBAAuB,EACzCC,EAAW,QAAS,wBAAyB,EAC7CC,EAAO,QAAS,6BAA8B,EAK9CC,EAASH,EAAQ,iCAAkC,EAyCnDI,EAAUL,EAAeG,EAAMC,EAAQF,EAAS,IAAK,4BAA6B,CAAE,EAKxFH,EAAO,QAAUM,IC5EjB,IAAAC,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,IA8BVC,EAAUD,EAAQ,EAKtBD,EAAO,QAAUE,ICKjB,IAAIC,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAU,IAKdF,EAAaC,EAAM,UAAWC,CAAQ,EAKtC,OAAO,QAAUD", - "names": ["require_factory", "__commonJSMin", "exports", "module", "binaryFactory", "dtypes", "defaults", "base", "DTYPES", "factory", "require_main", "__commonJSMin", "exports", "module", "factory", "uniform", "setReadOnly", "main", "factory"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index af6976c..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,198 +0,0 @@ - -{{alias}}( len, a, b[, options] ) - Returns an array containing pseudorandom numbers drawn from a continuous - uniform distribution. - - Parameters - ---------- - len: integer - Output array length. - - a: number - Minimum support. - - b: number - Maximum support. - - 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 ) - - - -{{alias}}.assign( a, b, out ) - Fills an array with pseudorandom numbers drawn from a continuous uniform - distribution. - - Parameters - ---------- - a: number - Minimum support. - - b: number - Maximum support. - - 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, x ) - - > var bool = ( out === x ) - true - - -{{alias}}.factory( [a, b, ][options] ) - Returns a function for creating arrays containing pseudorandom numbers drawn - from a continuous uniform 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. - - 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 ) - - - // Provide distribution parameters: - > fcn = {{alias}}.factory( 2.0, 5.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 ) - - - // Get a copy of the current state: - > var state = {{alias}}.state - - - > out = {{alias}}( 3, 2.0, 5.0 ) - - > out = {{alias}}( 3, 2.0, 5.0 ) - - - // Set the state: - > {{alias}}.state = state; - - // Regenerate a previous array: - > out = {{alias}}( 3, 2.0, 5.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 9e8939e..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,409 +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. -*/ - -import zeros = require( '@stdlib/array-zeros' ); -import random = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - random( 10, 2.0, 5.0 ); // $ExpectType RandomArray - random( 10, 2.0, 5.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 ); // $ExpectError - random( true, 2.0, 5.0 ); // $ExpectError - random( false, 2.0, 5.0 ); // $ExpectError - random( null, 2.0, 5.0 ); // $ExpectError - random( [], 2.0, 5.0 ); // $ExpectError - random( {}, 2.0, 5.0 ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - random( '5', 2.0, 5.0, {} ); // $ExpectError - random( true, 2.0, 5.0, {} ); // $ExpectError - random( false, 2.0, 5.0, {} ); // $ExpectError - random( null, 2.0, 5.0, {} ); // $ExpectError - random( [], 2.0, 5.0, {} ); // $ExpectError - random( {}, 2.0, 5.0, {} ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.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 ); // $ExpectError - random( 10, true, 5.0 ); // $ExpectError - random( 10, false, 5.0 ); // $ExpectError - random( 10, null, 5.0 ); // $ExpectError - random( 10, [], 5.0 ); // $ExpectError - random( 10, {}, 5.0 ); // $ExpectError - random( 10, ( x: number ): number => x, 5.0 ); // $ExpectError - - random( 10, '5', 5.0, {} ); // $ExpectError - random( 10, true, 5.0, {} ); // $ExpectError - random( 10, false, 5.0, {} ); // $ExpectError - random( 10, null, 5.0, {} ); // $ExpectError - random( 10, [], 5.0, {} ); // $ExpectError - random( 10, {}, 5.0, {} ); // $ExpectError - random( 10, ( x: number ): number => x, 5.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' ); // $ExpectError - random( 10, 2.0, true ); // $ExpectError - random( 10, 2.0, false ); // $ExpectError - random( 10, 2.0, null ); // $ExpectError - random( 10, 2.0, [] ); // $ExpectError - random( 10, 2.0, {} ); // $ExpectError - random( 10, 2.0, ( x: number ): number => x ); // $ExpectError - - random( 10, 2.0, '5', {} ); // $ExpectError - random( 10, 2.0, true, {} ); // $ExpectError - random( 10, 2.0, false, {} ); // $ExpectError - random( 10, 2.0, null, {} ); // $ExpectError - random( 10, 2.0, [], {} ); // $ExpectError - random( 10, 2.0, {}, {} ); // $ExpectError - random( 10, 2.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, '5' ); // $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, [] ); // $ExpectError - random( 10, 2.0, 5.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, { 'dtype': 123 } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': null } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - random( 10, 2.0, 5.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 -} - -// Attached to the main export is an `assign` method which returns an array... -{ - const x = zeros( 10, 'float64' ); - - random.assign( 2.0, 5.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, x ); // $ExpectError - random.assign( true, 5.0, x ); // $ExpectError - random.assign( false, 5.0, x ); // $ExpectError - random.assign( null, 5.0, x ); // $ExpectError - random.assign( [], 5.0, x ); // $ExpectError - random.assign( {}, 5.0, x ); // $ExpectError - random.assign( ( x: number ): number => x, 5.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', x ); // $ExpectError - random.assign( 2.0, true, x ); // $ExpectError - random.assign( 2.0, false, x ); // $ExpectError - random.assign( 2.0, null, x ); // $ExpectError - random.assign( 2.0, [], x ); // $ExpectError - random.assign( 2.0, {}, x ); // $ExpectError - random.assign( 2.0, ( x: number ): number => x, x ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid output array... -{ - random.assign( 2.0, 5.0, '5' ); // $ExpectError - random.assign( 2.0, 5.0, 5 ); // $ExpectError - random.assign( 2.0, 5.0, true ); // $ExpectError - random.assign( 2.0, 5.0, false ); // $ExpectError - random.assign( 2.0, 5.0, null ); // $ExpectError - random.assign( 2.0, 5.0, {} ); // $ExpectError - random.assign( 2.0, 5.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const 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 -} - -// Attached to main export is a `factory` method which returns a function... -{ - random.factory( 2.0, 5.0 ); // $ExpectType UnaryFunction - random.factory( 2.0, 5.0, { 'copy': false } ); // $ExpectType UnaryFunction - - random.factory(); // $ExpectType TernaryFunction - random.factory( { 'copy': false } ); // $ExpectType TernaryFunction -} - -// The `factory` method returns a function which returns an array... -{ - const fcn1 = random.factory( 2.0, 5.0 ); - fcn1( 10 ); // $ExpectType RandomArray - - const fcn2 = random.factory(); - fcn2( 10, 2.0, 5.0 ); // $ExpectType RandomArray -} - -// The compiler throws an error if the `factory` method is provided invalid arguments... -{ - random.factory( '5', 5.0 ); // $ExpectError - random.factory( true, 5.0 ); // $ExpectError - random.factory( false, 5.0 ); // $ExpectError - random.factory( [], 5.0 ); // $ExpectError - random.factory( {}, 5.0 ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0 ); // $ExpectError - - random.factory( '5', 5.0, {} ); // $ExpectError - random.factory( true, 5.0, {} ); // $ExpectError - random.factory( false, 5.0, {} ); // $ExpectError - random.factory( [], 5.0, {} ); // $ExpectError - random.factory( {}, 5.0, {} ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0, {} ); // $ExpectError - - random.factory( 2.0, '5' ); // $ExpectError - random.factory( 2.0, true ); // $ExpectError - random.factory( 2.0, false ); // $ExpectError - random.factory( 2.0, [] ); // $ExpectError - random.factory( 2.0, {} ); // $ExpectError - random.factory( 2.0, ( x: number ): number => x ); // $ExpectError - - random.factory( 2.0, '5', {} ); // $ExpectError - random.factory( 2.0, true, {} ); // $ExpectError - random.factory( 2.0, false, {} ); // $ExpectError - random.factory( 2.0, [], {} ); // $ExpectError - random.factory( 2.0, {}, {} ); // $ExpectError - random.factory( 2.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, 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, { 'prng': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'seed': true } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': [ 'a' ] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'state': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': {} } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': true } ); // $ExpectError - random.factory( 2.0, 5.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, { 'copy': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'dtype': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - random.factory( 2.0, 5.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, {}, {} ); // $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 ); - 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 ); // $ExpectError - fcn2( false, 2.0, 5.0 ); // $ExpectError - fcn2( '5', 2.0, 5.0 ); // $ExpectError - fcn2( [], 2.0, 5.0 ); // $ExpectError - fcn2( {}, 2.0, 5.0 ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - fcn2( true, 2.0, 5.0, {} ); // $ExpectError - fcn2( false, 2.0, 5.0, {} ); // $ExpectError - fcn2( '5', 2.0, 5.0, {} ); // $ExpectError - fcn2( [], 2.0, 5.0, {} ); // $ExpectError - fcn2( {}, 2.0, 5.0, {} ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0, {} ); // $ExpectError - - fcn2( 10, true, 5.0 ); // $ExpectError - fcn2( 10, false, 5.0 ); // $ExpectError - fcn2( 10, '5', 5.0 ); // $ExpectError - fcn2( 10, [], 5.0 ); // $ExpectError - fcn2( 10, {}, 5.0 ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0 ); // $ExpectError - - fcn2( 10, true, 5.0, {} ); // $ExpectError - fcn2( 10, false, 5.0, {} ); // $ExpectError - fcn2( 10, '5', 5.0, {} ); // $ExpectError - fcn2( 10, [], 5.0, {} ); // $ExpectError - fcn2( 10, {}, 5.0, {} ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0, {} ); // $ExpectError - - fcn2( 10, 2.0, true ); // $ExpectError - fcn2( 10, 2.0, false ); // $ExpectError - fcn2( 10, 2.0, '5' ); // $ExpectError - fcn2( 10, 2.0, [] ); // $ExpectError - fcn2( 10, 2.0, {} ); // $ExpectError - fcn2( 10, 2.0, ( x: number ): number => x ); // $ExpectError - - fcn2( 10, 2.0, true, {} ); // $ExpectError - fcn2( 10, 2.0, false, {} ); // $ExpectError - fcn2( 10, 2.0, '5', {} ); // $ExpectError - fcn2( 10, 2.0, [], {} ); // $ExpectError - fcn2( 10, 2.0, {}, {} ); // $ExpectError - fcn2( 10, 2.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, { 'dtype': 123 } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': null } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError - - const fcn2 = random.factory( 2.0, 5.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 ); - fcn1(); // $ExpectError - fcn1( 1, 1, 1 ); // $ExpectError - - const fcn2 = random.factory(); - fcn2(); // $ExpectError - fcn2( 1 ); // $ExpectError - fcn2( 1, 1, 1, 1 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index c485546..0000000 --- a/examples/index.js +++ /dev/null @@ -1,48 +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'; - -var logEach = require( '@stdlib/console-log-each' ); -var uniform = require( './../lib' ); - -// Create a function for generating random arrays originating from the same state: -var random = uniform.factory( 2.0, 5.0, { - 'state': uniform.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 = uniform.factory( 2.0, 5.0, { - 'state': uniform.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 9a727e8..2935269 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..883e5f3 --- /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-binary-factory@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtypes@v0.1.0-esm/index.mjs";import r 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-uniform@v0.1.0-esm/index.mjs";var d=e(n,s("real_floating_point_and_generic"),r.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..4e9834a --- /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) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 binaryFactory from '@stdlib/random-array-tools-binary-factory';\nimport dtypes from '@stdlib/array-dtypes';\nimport defaults from '@stdlib/array-defaults';\nimport base from '@stdlib/random-base-uniform';\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 continuous uniform distribution.\n*\n* @name factory\n* @type {Function}\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\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} 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 uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10 );\n* // returns \n*\n* @example\n* var uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar factory = binaryFactory( 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) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution.\n*\n* @name uniform\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\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 = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar uniform = factory();\n\n\n// EXPORTS //\n\nexport default uniform;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution.\n*\n* @module @stdlib/random-array-uniform\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.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","binaryFactory","base","dtypes","defaults","get","uniform","setReadOnly","main"],"mappings":";;2eA8BA,IAyCIA,EAAUC,EAAeC,EAzChBC,EAAQ,mCAyCsBC,EAASC,IAAK,+BCnBrDC,EAAUN,ICiBdO,EAAAC,EAAA,UAAAR"} \ No newline at end of file diff --git a/lib/factory.js b/lib/factory.js deleted file mode 100644 index 79da171..0000000 --- a/lib/factory.js +++ /dev/null @@ -1,77 +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 binaryFactory = require( '@stdlib/random-array-tools-binary-factory' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var defaults = require( '@stdlib/array-defaults' ); -var base = require( '@stdlib/random-base-uniform' ); - - -// VARIABLES // - -var DTYPES = dtypes( 'real_floating_point_and_generic' ); - - -// MAIN // - -/** -* Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution. -* -* @name factory -* @type {Function} -* @param {number} [a] - minimum support -* @param {number} [b] - maximum support -* @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} 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 uniform = factory( 2.0, 5.0 ); -* // returns -* -* var arr = uniform( 10 ); -* // returns -* -* @example -* var uniform = factory( 2.0, 5.0 ); -* // returns -* -* var arr = uniform( 10, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -var factory = binaryFactory( 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 3376c12..0000000 --- a/lib/index.js +++ /dev/null @@ -1,77 +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'; - -/** -* Create an array containing pseudorandom numbers drawn from a continuous uniform distribution. -* -* @module @stdlib/random-array-uniform -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var arr = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var arr = uniform( 10, 2.0, 5.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var rand = uniform.factory( 2.0, 5.0 ); -* // returns -* -* var arr = rand( 10 ); -* // returns -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var rand = uniform.factory( 2.0, 5.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 f93ef8f..0000000 --- a/lib/main.js +++ /dev/null @@ -1,58 +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 factory = require( './factory.js' ); - - -// MAIN // - -/** -* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution. -* -* @name uniform -* @type {Function} -* @param {NonNegativeInteger} len - array length -* @param {number} a - minimum support -* @param {number} b - maximum support -* @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 = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var arr = uniform( 10, 2.0, 5.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -var uniform = factory(); - - -// EXPORTS // - -module.exports = uniform; diff --git a/package.json b/package.json index f38f80e..767a213 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 continuous uniform 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-binary-factory": "^0.1.0", - "@stdlib/random-base-uniform": "^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..6a386fe --- /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 14d34c7..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, 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, 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, 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, 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 765abb1..0000000 --- a/test/test.factory.js +++ /dev/null @@ -1,1261 +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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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, 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, { - '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, { - '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, { - '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, { - '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, { - '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, { - '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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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 ); - - 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 ); - - 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, { - '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 ); - - 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 ); - 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 ); - - 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 ); - - 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 ); - - 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 ); - - 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, { - '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 ); - - 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, { - '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 ); - - 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, { - '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 ); - - 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, { - '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 ); - - 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, { - '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, { - '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 ); - - // 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, { - '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 ); - - // 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, { - '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 ); - - 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, { - 'prng': randu.normalized - }); - - randu = minstd.factory({ - 'seed': seed - }); - random2 = factory( 2.0, 5.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 ); - arr2 = random2( 10, 2.0, 5.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 4e0f74d..0000000 --- a/test/test.js +++ /dev/null @@ -1,74 +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 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 faf9d84..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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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, 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, { - '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 ); - - 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, { - '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, { - '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, { - '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 ); - } - // Capture the current state: - state = random.state; - - // Move to a future state... - arr = random( 10, 2.0, 5.0 ); - for ( i = 0; i < 100; i++ ) { - random( 2, 2.0, 5.0 ); - } - // Set the state: - random.state = state; - - // Replay previously generated values: - t.deepEqual( random( 10, 2.0, 5.0 ), arr, 'returns expected value' ); - - t.end(); -}); From 1da232d541c41130b451e1a55a0e93b0a71b8fb0 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 15 Feb 2024 02:11:41 +0000 Subject: [PATCH 58/82] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 5c4a41c..a5333a9 100644 --- a/package.json +++ b/package.json @@ -42,7 +42,8 @@ "@stdlib/random-array-tools-binary-factory": "^0.2.0", "@stdlib/random-base-uniform": "^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 07bf859240d735f521d7f0ed2e3f3acfcb2114e1 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 15 Feb 2024 05:55:41 +0000 Subject: [PATCH 59/82] Remove files --- index.d.ts | 279 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6461 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 2935269..0000000 --- a/index.d.ts +++ /dev/null @@ -1,279 +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. -*/ - -// 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 continuous uniform distribution with pre-specified parameter values. -*/ -interface UnaryFunction extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform 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 continuous uniform distribution. - * - * @param out - output array - * @returns output array - */ - assign( out: RandomArray ): RandomArray; -} - -/** -* Interface for generating pseudorandom numbers drawn from a continuous uniform distribution without pre-specified parameter values. -*/ -interface TernaryFunction extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution. - * - * @param len - array length - * @param a - minimum support - * @param b - maximum support - * @param options - function options - * @returns output array - */ - ( len: number, a: number, b: number, options?: Options ): RandomArray; - - /** - * Fills an array with pseudorandom numbers drawn from a continuous uniform distribution. - * - * @param a - minimum support - * @param b - maximum support - * @param out - output array - * @returns output array - */ - assign( a: number, b: number, out: RandomArray ): RandomArray; -} - -/** -* Interface for generating pseudorandom numbers drawn from a continuous uniform distribution. -*/ -interface Random extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution. - * - * @param len - array length - * @param a - minimum support - * @param b - maximum support - * @param options - function options - * @returns output array - * - * @example - * var out = uniform( 10, 2.0, 5.0 ); - * // returns - */ - ( len: number, a: number, b: number, options?: Options ): RandomArray; - - /** - * Fills an array with pseudorandom numbers drawn from a continuous uniform distribution. - * - * @param a - minimum support - * @param b - maximum support - * @param out - output array - * @returns output array - * - * @example - * var zeros = require( '@stdlib/array-zeros' ); - * - * var x = zeros( 10, 'float64' ); - * // returns - * - * var out = uniform( 2.0, 5.0, out ); - * // returns - * - * var bool = ( out === x ); - * // returns true - */ - assign( a: number, b: number, out: RandomArray ): RandomArray; - - /** - * Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform 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 options - function options - * @throws must provide a valid state - * @returns function for creating arrays - * - * @example - * var random = uniform.factory( 2.0, 5.0 ); - * - * var out = random( 10 ); - * // returns - * - * @example - * var random = uniform.factory( 2.0, 5.0, { - * 'seed': 297 - * }); - * var out = random( 10 ); - * // returns - */ - factory( a: number, b: number, options?: FactoryOptions ): UnaryFunction; - - /** - * Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform 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 = uniform.factory(); - * - * var out = random( 10, 2.0, 5.0 ); - * // returns - * - * @example - * var random = uniform.factory({ - * 'seed': 297 - * }); - * var out = random( 10, 2.0, 5.0 ); - * // returns - */ - factory( options?: FactoryOptions ): TernaryFunction; -} - -/** -* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution. -* -* @param len - array length -* @param a - minimum support -* @param b - maximum support -* @param options - function options -* @returns output array -* -* @example -* var out = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var random = uniform.factory( 2.0, 5.0 ); -* -* var out = random( 10 ); -* // returns -*/ -declare var uniform: Random; - - -// EXPORTS // - -export = uniform; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 883e5f3..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-binary-factory@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtypes@v0.1.0-esm/index.mjs";import r 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-uniform@v0.1.0-esm/index.mjs";var d=e(n,s("real_floating_point_and_generic"),r.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 4e9834a..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) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 binaryFactory from '@stdlib/random-array-tools-binary-factory';\nimport dtypes from '@stdlib/array-dtypes';\nimport defaults from '@stdlib/array-defaults';\nimport base from '@stdlib/random-base-uniform';\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 continuous uniform distribution.\n*\n* @name factory\n* @type {Function}\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\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} 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 uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10 );\n* // returns \n*\n* @example\n* var uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar factory = binaryFactory( 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) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution.\n*\n* @name uniform\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\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 = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar uniform = factory();\n\n\n// EXPORTS //\n\nexport default uniform;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution.\n*\n* @module @stdlib/random-array-uniform\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.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","binaryFactory","base","dtypes","defaults","get","uniform","setReadOnly","main"],"mappings":";;2eA8BA,IAyCIA,EAAUC,EAAeC,EAzChBC,EAAQ,mCAyCsBC,EAASC,IAAK,+BCnBrDC,EAAUN,ICiBdO,EAAAC,EAAA,UAAAR"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 6a386fe..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 0fddc084e38567998a6616dd3e247393c150dff9 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 15 Feb 2024 05:56:58 +0000 Subject: [PATCH 60/82] 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 | 69 +- 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 | 198 - docs/types/test.ts | 409 -- examples/index.js | 48 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/factory.js | 77 - lib/index.js | 77 - lib/main.js | 58 - package.json | 71 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 118 - test/test.factory.js | 1261 ----- test/test.js | 74 - test/test.main.js | 244 - 54 files changed, 6219 insertions(+), 6820 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 c4ab52b..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/uniform) 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 5097056..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/uniform) 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 d29606d..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: '33 9 * * 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,19 +468,19 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/random-array-uniform/main/LICENSE -[@stdlib/random/base/uniform]: https://github.com/stdlib-js/random-base-uniform +[@stdlib/random/base/uniform]: https://github.com/stdlib-js/random-base-uniform/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 -[@stdlib/random/array/discrete-uniform]: https://github.com/stdlib-js/random-array-discrete-uniform +[@stdlib/random/array/discrete-uniform]: https://github.com/stdlib-js/random-array-discrete-uniform/tree/esm -[@stdlib/random/strided/uniform]: https://github.com/stdlib-js/random-strided-uniform +[@stdlib/random/strided/uniform]: https://github.com/stdlib-js/random-strided-uniform/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 4923816..0000000 --- a/benchmark/benchmark.float32.assign.js +++ /dev/null @@ -1,97 +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 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, 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 dea0644..0000000 --- a/benchmark/benchmark.float32.factory.js +++ /dev/null @@ -1,96 +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 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, { - '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 4249752..0000000 --- a/benchmark/benchmark.float32.js +++ /dev/null @@ -1,98 +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 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, 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 8cf1538..0000000 --- a/benchmark/benchmark.float64.assign.js +++ /dev/null @@ -1,97 +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 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, 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 f352bca..0000000 --- a/benchmark/benchmark.float64.factory.js +++ /dev/null @@ -1,96 +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 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, { - '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 e176e0a..0000000 --- a/benchmark/benchmark.float64.js +++ /dev/null @@ -1,98 +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 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, 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 6038ee7..0000000 --- a/benchmark/benchmark.generic.assign.js +++ /dev/null @@ -1,97 +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 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, 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 6a6bddc..0000000 --- a/benchmark/benchmark.generic.factory.js +++ /dev/null @@ -1,96 +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 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, { - '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 b6bdcfd..0000000 --- a/benchmark/benchmark.generic.js +++ /dev/null @@ -1,98 +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 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, 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 5a79fd6..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/uniform" -%% click B href "https://github.com/stdlib-js/random-array-uniform/tree/main" -%% click C href "https://github.com/stdlib-js/random-array-uniform/tree/production" -%% click D href "https://github.com/stdlib-js/random-array-uniform/tree/esm" -%% click E href "https://github.com/stdlib-js/random-array-uniform/tree/deno" -%% click F href "https://github.com/stdlib-js/random-array-uniform/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/uniform -[production-url]: https://github.com/stdlib-js/random-array-uniform/tree/production -[deno-url]: https://github.com/stdlib-js/random-array-uniform/tree/deno -[deno-readme]: https://github.com/stdlib-js/random-array-uniform/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/random-array-uniform/tree/umd -[umd-readme]: https://github.com/stdlib-js/random-array-uniform/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/random-array-uniform/tree/esm -[esm-readme]: https://github.com/stdlib-js/random-array-uniform/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 f2a679f..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import uniform from '../docs/types/index'; -export = uniform; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index f49a668..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var a=function(u,r){return function(){return r||u((r={exports:{}}).exports,r),r.exports}};var e=a(function(x,t){ -var v=require('@stdlib/random-array-tools-binary-factory/dist'),n=require('@stdlib/array-dtypes/dist'),c=require('@stdlib/array-defaults/dist'),y=require('@stdlib/random-base-uniform/dist'),f=n("real_floating_point_and_generic"),q=v(y,f,c.get("dtypes.real_floating_point"));t.exports=q -});var s=a(function(b,i){ -var p=e(),l=p();i.exports=l -});var _=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),o=s(),d=e();_(o,"factory",d);module.exports=o; -/** @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 815b1ac..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) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 binaryFactory = require( '@stdlib/random-array-tools-binary-factory' );\nvar dtypes = require( '@stdlib/array-dtypes' );\nvar defaults = require( '@stdlib/array-defaults' );\nvar base = require( '@stdlib/random-base-uniform' );\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 continuous uniform distribution.\n*\n* @name factory\n* @type {Function}\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\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} 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 uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10 );\n* // returns \n*\n* @example\n* var uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar factory = binaryFactory( 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) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution.\n*\n* @name uniform\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\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 = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar uniform = factory();\n\n\n// EXPORTS //\n\nmodule.exports = uniform;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution.\n*\n* @module @stdlib/random-array-uniform\n*\n* @example\n* var uniform = require( '@stdlib/random-array-uniform' );\n*\n* var arr = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var uniform = require( '@stdlib/random-array-uniform' );\n*\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* var uniform = require( '@stdlib/random-array-uniform' );\n*\n* var rand = uniform.factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* var uniform = require( '@stdlib/random-array-uniform' );\n*\n* var rand = uniform.factory( 2.0, 5.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,EAAgB,QAAS,2CAA4C,EACrEC,EAAS,QAAS,sBAAuB,EACzCC,EAAW,QAAS,wBAAyB,EAC7CC,EAAO,QAAS,6BAA8B,EAK9CC,EAASH,EAAQ,iCAAkC,EAyCnDI,EAAUL,EAAeG,EAAMC,EAAQF,EAAS,IAAK,4BAA6B,CAAE,EAKxFH,EAAO,QAAUM,IC5EjB,IAAAC,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,IA8BVC,EAAUD,EAAQ,EAKtBD,EAAO,QAAUE,ICKjB,IAAIC,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAU,IAKdF,EAAaC,EAAM,UAAWC,CAAQ,EAKtC,OAAO,QAAUD", - "names": ["require_factory", "__commonJSMin", "exports", "module", "binaryFactory", "dtypes", "defaults", "base", "DTYPES", "factory", "require_main", "__commonJSMin", "exports", "module", "factory", "uniform", "setReadOnly", "main", "factory"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index af6976c..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,198 +0,0 @@ - -{{alias}}( len, a, b[, options] ) - Returns an array containing pseudorandom numbers drawn from a continuous - uniform distribution. - - Parameters - ---------- - len: integer - Output array length. - - a: number - Minimum support. - - b: number - Maximum support. - - 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 ) - - - -{{alias}}.assign( a, b, out ) - Fills an array with pseudorandom numbers drawn from a continuous uniform - distribution. - - Parameters - ---------- - a: number - Minimum support. - - b: number - Maximum support. - - 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, x ) - - > var bool = ( out === x ) - true - - -{{alias}}.factory( [a, b, ][options] ) - Returns a function for creating arrays containing pseudorandom numbers drawn - from a continuous uniform 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. - - 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 ) - - - // Provide distribution parameters: - > fcn = {{alias}}.factory( 2.0, 5.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 ) - - - // Get a copy of the current state: - > var state = {{alias}}.state - - - > out = {{alias}}( 3, 2.0, 5.0 ) - - > out = {{alias}}( 3, 2.0, 5.0 ) - - - // Set the state: - > {{alias}}.state = state; - - // Regenerate a previous array: - > out = {{alias}}( 3, 2.0, 5.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 9e8939e..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,409 +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. -*/ - -import zeros = require( '@stdlib/array-zeros' ); -import random = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - random( 10, 2.0, 5.0 ); // $ExpectType RandomArray - random( 10, 2.0, 5.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 ); // $ExpectError - random( true, 2.0, 5.0 ); // $ExpectError - random( false, 2.0, 5.0 ); // $ExpectError - random( null, 2.0, 5.0 ); // $ExpectError - random( [], 2.0, 5.0 ); // $ExpectError - random( {}, 2.0, 5.0 ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - random( '5', 2.0, 5.0, {} ); // $ExpectError - random( true, 2.0, 5.0, {} ); // $ExpectError - random( false, 2.0, 5.0, {} ); // $ExpectError - random( null, 2.0, 5.0, {} ); // $ExpectError - random( [], 2.0, 5.0, {} ); // $ExpectError - random( {}, 2.0, 5.0, {} ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.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 ); // $ExpectError - random( 10, true, 5.0 ); // $ExpectError - random( 10, false, 5.0 ); // $ExpectError - random( 10, null, 5.0 ); // $ExpectError - random( 10, [], 5.0 ); // $ExpectError - random( 10, {}, 5.0 ); // $ExpectError - random( 10, ( x: number ): number => x, 5.0 ); // $ExpectError - - random( 10, '5', 5.0, {} ); // $ExpectError - random( 10, true, 5.0, {} ); // $ExpectError - random( 10, false, 5.0, {} ); // $ExpectError - random( 10, null, 5.0, {} ); // $ExpectError - random( 10, [], 5.0, {} ); // $ExpectError - random( 10, {}, 5.0, {} ); // $ExpectError - random( 10, ( x: number ): number => x, 5.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' ); // $ExpectError - random( 10, 2.0, true ); // $ExpectError - random( 10, 2.0, false ); // $ExpectError - random( 10, 2.0, null ); // $ExpectError - random( 10, 2.0, [] ); // $ExpectError - random( 10, 2.0, {} ); // $ExpectError - random( 10, 2.0, ( x: number ): number => x ); // $ExpectError - - random( 10, 2.0, '5', {} ); // $ExpectError - random( 10, 2.0, true, {} ); // $ExpectError - random( 10, 2.0, false, {} ); // $ExpectError - random( 10, 2.0, null, {} ); // $ExpectError - random( 10, 2.0, [], {} ); // $ExpectError - random( 10, 2.0, {}, {} ); // $ExpectError - random( 10, 2.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, '5' ); // $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, [] ); // $ExpectError - random( 10, 2.0, 5.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, { 'dtype': 123 } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': null } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - random( 10, 2.0, 5.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 -} - -// Attached to the main export is an `assign` method which returns an array... -{ - const x = zeros( 10, 'float64' ); - - random.assign( 2.0, 5.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, x ); // $ExpectError - random.assign( true, 5.0, x ); // $ExpectError - random.assign( false, 5.0, x ); // $ExpectError - random.assign( null, 5.0, x ); // $ExpectError - random.assign( [], 5.0, x ); // $ExpectError - random.assign( {}, 5.0, x ); // $ExpectError - random.assign( ( x: number ): number => x, 5.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', x ); // $ExpectError - random.assign( 2.0, true, x ); // $ExpectError - random.assign( 2.0, false, x ); // $ExpectError - random.assign( 2.0, null, x ); // $ExpectError - random.assign( 2.0, [], x ); // $ExpectError - random.assign( 2.0, {}, x ); // $ExpectError - random.assign( 2.0, ( x: number ): number => x, x ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid output array... -{ - random.assign( 2.0, 5.0, '5' ); // $ExpectError - random.assign( 2.0, 5.0, 5 ); // $ExpectError - random.assign( 2.0, 5.0, true ); // $ExpectError - random.assign( 2.0, 5.0, false ); // $ExpectError - random.assign( 2.0, 5.0, null ); // $ExpectError - random.assign( 2.0, 5.0, {} ); // $ExpectError - random.assign( 2.0, 5.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const 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 -} - -// Attached to main export is a `factory` method which returns a function... -{ - random.factory( 2.0, 5.0 ); // $ExpectType UnaryFunction - random.factory( 2.0, 5.0, { 'copy': false } ); // $ExpectType UnaryFunction - - random.factory(); // $ExpectType TernaryFunction - random.factory( { 'copy': false } ); // $ExpectType TernaryFunction -} - -// The `factory` method returns a function which returns an array... -{ - const fcn1 = random.factory( 2.0, 5.0 ); - fcn1( 10 ); // $ExpectType RandomArray - - const fcn2 = random.factory(); - fcn2( 10, 2.0, 5.0 ); // $ExpectType RandomArray -} - -// The compiler throws an error if the `factory` method is provided invalid arguments... -{ - random.factory( '5', 5.0 ); // $ExpectError - random.factory( true, 5.0 ); // $ExpectError - random.factory( false, 5.0 ); // $ExpectError - random.factory( [], 5.0 ); // $ExpectError - random.factory( {}, 5.0 ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0 ); // $ExpectError - - random.factory( '5', 5.0, {} ); // $ExpectError - random.factory( true, 5.0, {} ); // $ExpectError - random.factory( false, 5.0, {} ); // $ExpectError - random.factory( [], 5.0, {} ); // $ExpectError - random.factory( {}, 5.0, {} ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0, {} ); // $ExpectError - - random.factory( 2.0, '5' ); // $ExpectError - random.factory( 2.0, true ); // $ExpectError - random.factory( 2.0, false ); // $ExpectError - random.factory( 2.0, [] ); // $ExpectError - random.factory( 2.0, {} ); // $ExpectError - random.factory( 2.0, ( x: number ): number => x ); // $ExpectError - - random.factory( 2.0, '5', {} ); // $ExpectError - random.factory( 2.0, true, {} ); // $ExpectError - random.factory( 2.0, false, {} ); // $ExpectError - random.factory( 2.0, [], {} ); // $ExpectError - random.factory( 2.0, {}, {} ); // $ExpectError - random.factory( 2.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, 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, { 'prng': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'seed': true } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': [ 'a' ] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'state': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': {} } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': true } ); // $ExpectError - random.factory( 2.0, 5.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, { 'copy': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'dtype': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - random.factory( 2.0, 5.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, {}, {} ); // $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 ); - 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 ); // $ExpectError - fcn2( false, 2.0, 5.0 ); // $ExpectError - fcn2( '5', 2.0, 5.0 ); // $ExpectError - fcn2( [], 2.0, 5.0 ); // $ExpectError - fcn2( {}, 2.0, 5.0 ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - fcn2( true, 2.0, 5.0, {} ); // $ExpectError - fcn2( false, 2.0, 5.0, {} ); // $ExpectError - fcn2( '5', 2.0, 5.0, {} ); // $ExpectError - fcn2( [], 2.0, 5.0, {} ); // $ExpectError - fcn2( {}, 2.0, 5.0, {} ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0, {} ); // $ExpectError - - fcn2( 10, true, 5.0 ); // $ExpectError - fcn2( 10, false, 5.0 ); // $ExpectError - fcn2( 10, '5', 5.0 ); // $ExpectError - fcn2( 10, [], 5.0 ); // $ExpectError - fcn2( 10, {}, 5.0 ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0 ); // $ExpectError - - fcn2( 10, true, 5.0, {} ); // $ExpectError - fcn2( 10, false, 5.0, {} ); // $ExpectError - fcn2( 10, '5', 5.0, {} ); // $ExpectError - fcn2( 10, [], 5.0, {} ); // $ExpectError - fcn2( 10, {}, 5.0, {} ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0, {} ); // $ExpectError - - fcn2( 10, 2.0, true ); // $ExpectError - fcn2( 10, 2.0, false ); // $ExpectError - fcn2( 10, 2.0, '5' ); // $ExpectError - fcn2( 10, 2.0, [] ); // $ExpectError - fcn2( 10, 2.0, {} ); // $ExpectError - fcn2( 10, 2.0, ( x: number ): number => x ); // $ExpectError - - fcn2( 10, 2.0, true, {} ); // $ExpectError - fcn2( 10, 2.0, false, {} ); // $ExpectError - fcn2( 10, 2.0, '5', {} ); // $ExpectError - fcn2( 10, 2.0, [], {} ); // $ExpectError - fcn2( 10, 2.0, {}, {} ); // $ExpectError - fcn2( 10, 2.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, { 'dtype': 123 } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': null } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError - - const fcn2 = random.factory( 2.0, 5.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 ); - fcn1(); // $ExpectError - fcn1( 1, 1, 1 ); // $ExpectError - - const fcn2 = random.factory(); - fcn2(); // $ExpectError - fcn2( 1 ); // $ExpectError - fcn2( 1, 1, 1, 1 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index c485546..0000000 --- a/examples/index.js +++ /dev/null @@ -1,48 +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'; - -var logEach = require( '@stdlib/console-log-each' ); -var uniform = require( './../lib' ); - -// Create a function for generating random arrays originating from the same state: -var random = uniform.factory( 2.0, 5.0, { - 'state': uniform.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 = uniform.factory( 2.0, 5.0, { - 'state': uniform.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 9a727e8..2935269 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..ac5b02b --- /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-binary-factory@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtypes@v0.2.0-esm/index.mjs";import r 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-uniform@v0.1.0-esm/index.mjs";var d=e(n,s("real_floating_point_and_generic"),r.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..4e9834a --- /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) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 binaryFactory from '@stdlib/random-array-tools-binary-factory';\nimport dtypes from '@stdlib/array-dtypes';\nimport defaults from '@stdlib/array-defaults';\nimport base from '@stdlib/random-base-uniform';\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 continuous uniform distribution.\n*\n* @name factory\n* @type {Function}\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\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} 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 uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10 );\n* // returns \n*\n* @example\n* var uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar factory = binaryFactory( 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) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution.\n*\n* @name uniform\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\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 = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar uniform = factory();\n\n\n// EXPORTS //\n\nexport default uniform;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution.\n*\n* @module @stdlib/random-array-uniform\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.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","binaryFactory","base","dtypes","defaults","get","uniform","setReadOnly","main"],"mappings":";;2eA8BA,IAyCIA,EAAUC,EAAeC,EAzChBC,EAAQ,mCAyCsBC,EAASC,IAAK,+BCnBrDC,EAAUN,ICiBdO,EAAAC,EAAA,UAAAR"} \ No newline at end of file diff --git a/lib/factory.js b/lib/factory.js deleted file mode 100644 index 79da171..0000000 --- a/lib/factory.js +++ /dev/null @@ -1,77 +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 binaryFactory = require( '@stdlib/random-array-tools-binary-factory' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var defaults = require( '@stdlib/array-defaults' ); -var base = require( '@stdlib/random-base-uniform' ); - - -// VARIABLES // - -var DTYPES = dtypes( 'real_floating_point_and_generic' ); - - -// MAIN // - -/** -* Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution. -* -* @name factory -* @type {Function} -* @param {number} [a] - minimum support -* @param {number} [b] - maximum support -* @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} 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 uniform = factory( 2.0, 5.0 ); -* // returns -* -* var arr = uniform( 10 ); -* // returns -* -* @example -* var uniform = factory( 2.0, 5.0 ); -* // returns -* -* var arr = uniform( 10, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -var factory = binaryFactory( 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 3376c12..0000000 --- a/lib/index.js +++ /dev/null @@ -1,77 +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'; - -/** -* Create an array containing pseudorandom numbers drawn from a continuous uniform distribution. -* -* @module @stdlib/random-array-uniform -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var arr = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var arr = uniform( 10, 2.0, 5.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var rand = uniform.factory( 2.0, 5.0 ); -* // returns -* -* var arr = rand( 10 ); -* // returns -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var rand = uniform.factory( 2.0, 5.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 f93ef8f..0000000 --- a/lib/main.js +++ /dev/null @@ -1,58 +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 factory = require( './factory.js' ); - - -// MAIN // - -/** -* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution. -* -* @name uniform -* @type {Function} -* @param {NonNegativeInteger} len - array length -* @param {number} a - minimum support -* @param {number} b - maximum support -* @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 = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var arr = uniform( 10, 2.0, 5.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -var uniform = factory(); - - -// EXPORTS // - -module.exports = uniform; diff --git a/package.json b/package.json index a5333a9..eb7385c 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 continuous uniform 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-binary-factory": "^0.2.0", - "@stdlib/random-base-uniform": "^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..e26c5f4 --- /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 14d34c7..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, 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, 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, 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, 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 765abb1..0000000 --- a/test/test.factory.js +++ /dev/null @@ -1,1261 +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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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, 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, { - '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, { - '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, { - '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, { - '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, { - '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, { - '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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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 ); - - 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 ); - - 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, { - '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 ); - - 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 ); - 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 ); - - 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 ); - - 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 ); - - 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 ); - - 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, { - '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 ); - - 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, { - '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 ); - - 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, { - '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 ); - - 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, { - '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 ); - - 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, { - '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, { - '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 ); - - // 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, { - '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 ); - - // 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, { - '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 ); - - 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, { - 'prng': randu.normalized - }); - - randu = minstd.factory({ - 'seed': seed - }); - random2 = factory( 2.0, 5.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 ); - arr2 = random2( 10, 2.0, 5.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 4e0f74d..0000000 --- a/test/test.js +++ /dev/null @@ -1,74 +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 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 faf9d84..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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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, 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, { - '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 ); - - 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, { - '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, { - '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, { - '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 ); - } - // Capture the current state: - state = random.state; - - // Move to a future state... - arr = random( 10, 2.0, 5.0 ); - for ( i = 0; i < 100; i++ ) { - random( 2, 2.0, 5.0 ); - } - // Set the state: - random.state = state; - - // Replay previously generated values: - t.deepEqual( random( 10, 2.0, 5.0 ), arr, 'returns expected value' ); - - t.end(); -}); From efcdb50b40fb6c060e7778763eef991cc82874ed Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 15 Feb 2024 06:47:21 +0000 Subject: [PATCH 61/82] 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 82c0c13..56a9513 100644 --- a/README.md +++ b/README.md @@ -42,13 +42,13 @@ limitations under the License. ## Usage ```javascript -import uniform from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-uniform@esm/index.mjs'; +import uniform from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-uniform@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-uniform@esm/index.mjs'; +import { factory } from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-uniform@v0.2.0-esm/index.mjs'; ``` #### uniform( len, a, b\[, options] ) @@ -343,7 +343,7 @@ var sz = random.byteLength; - - - - From 73745e131d60b2ad94bd0832f6acf1a527e5506b Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 25 Feb 2024 21:58:23 +0000 Subject: [PATCH 65/82] 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 | 69 +- 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 | 198 - docs/types/test.ts | 409 -- examples/index.js | 48 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/factory.js | 77 - lib/index.js | 77 - lib/main.js | 58 - package.json | 71 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 118 - test/test.factory.js | 1261 ------ test/test.js | 74 - test/test.main.js | 244 -- 54 files changed, 4884 insertions(+), 6814 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 c4ab52b..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/uniform) 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 5097056..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/uniform) 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 31ea6a7..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: '33 9 * * 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,19 +468,19 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/random-array-uniform/main/LICENSE -[@stdlib/random/base/uniform]: https://github.com/stdlib-js/random-base-uniform +[@stdlib/random/base/uniform]: https://github.com/stdlib-js/random-base-uniform/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 -[@stdlib/random/array/discrete-uniform]: https://github.com/stdlib-js/random-array-discrete-uniform +[@stdlib/random/array/discrete-uniform]: https://github.com/stdlib-js/random-array-discrete-uniform/tree/esm -[@stdlib/random/strided/uniform]: https://github.com/stdlib-js/random-strided-uniform +[@stdlib/random/strided/uniform]: https://github.com/stdlib-js/random-strided-uniform/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 4923816..0000000 --- a/benchmark/benchmark.float32.assign.js +++ /dev/null @@ -1,97 +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 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, 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 dea0644..0000000 --- a/benchmark/benchmark.float32.factory.js +++ /dev/null @@ -1,96 +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 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, { - '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 4249752..0000000 --- a/benchmark/benchmark.float32.js +++ /dev/null @@ -1,98 +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 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, 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 8cf1538..0000000 --- a/benchmark/benchmark.float64.assign.js +++ /dev/null @@ -1,97 +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 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, 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 f352bca..0000000 --- a/benchmark/benchmark.float64.factory.js +++ /dev/null @@ -1,96 +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 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, { - '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 e176e0a..0000000 --- a/benchmark/benchmark.float64.js +++ /dev/null @@ -1,98 +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 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, 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 6038ee7..0000000 --- a/benchmark/benchmark.generic.assign.js +++ /dev/null @@ -1,97 +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 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, 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 6a6bddc..0000000 --- a/benchmark/benchmark.generic.factory.js +++ /dev/null @@ -1,96 +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 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, { - '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 b6bdcfd..0000000 --- a/benchmark/benchmark.generic.js +++ /dev/null @@ -1,98 +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 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, 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 5a79fd6..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/uniform" -%% click B href "https://github.com/stdlib-js/random-array-uniform/tree/main" -%% click C href "https://github.com/stdlib-js/random-array-uniform/tree/production" -%% click D href "https://github.com/stdlib-js/random-array-uniform/tree/esm" -%% click E href "https://github.com/stdlib-js/random-array-uniform/tree/deno" -%% click F href "https://github.com/stdlib-js/random-array-uniform/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/uniform -[production-url]: https://github.com/stdlib-js/random-array-uniform/tree/production -[deno-url]: https://github.com/stdlib-js/random-array-uniform/tree/deno -[deno-readme]: https://github.com/stdlib-js/random-array-uniform/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/random-array-uniform/tree/umd -[umd-readme]: https://github.com/stdlib-js/random-array-uniform/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/random-array-uniform/tree/esm -[esm-readme]: https://github.com/stdlib-js/random-array-uniform/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 f2a679f..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import uniform from '../docs/types/index'; -export = uniform; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index f49a668..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var a=function(u,r){return function(){return r||u((r={exports:{}}).exports,r),r.exports}};var e=a(function(x,t){ -var v=require('@stdlib/random-array-tools-binary-factory/dist'),n=require('@stdlib/array-dtypes/dist'),c=require('@stdlib/array-defaults/dist'),y=require('@stdlib/random-base-uniform/dist'),f=n("real_floating_point_and_generic"),q=v(y,f,c.get("dtypes.real_floating_point"));t.exports=q -});var s=a(function(b,i){ -var p=e(),l=p();i.exports=l -});var _=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),o=s(),d=e();_(o,"factory",d);module.exports=o; -/** @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 815b1ac..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) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 binaryFactory = require( '@stdlib/random-array-tools-binary-factory' );\nvar dtypes = require( '@stdlib/array-dtypes' );\nvar defaults = require( '@stdlib/array-defaults' );\nvar base = require( '@stdlib/random-base-uniform' );\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 continuous uniform distribution.\n*\n* @name factory\n* @type {Function}\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\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} 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 uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10 );\n* // returns \n*\n* @example\n* var uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar factory = binaryFactory( 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) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution.\n*\n* @name uniform\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\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 = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar uniform = factory();\n\n\n// EXPORTS //\n\nmodule.exports = uniform;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution.\n*\n* @module @stdlib/random-array-uniform\n*\n* @example\n* var uniform = require( '@stdlib/random-array-uniform' );\n*\n* var arr = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var uniform = require( '@stdlib/random-array-uniform' );\n*\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* var uniform = require( '@stdlib/random-array-uniform' );\n*\n* var rand = uniform.factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* var uniform = require( '@stdlib/random-array-uniform' );\n*\n* var rand = uniform.factory( 2.0, 5.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,EAAgB,QAAS,2CAA4C,EACrEC,EAAS,QAAS,sBAAuB,EACzCC,EAAW,QAAS,wBAAyB,EAC7CC,EAAO,QAAS,6BAA8B,EAK9CC,EAASH,EAAQ,iCAAkC,EAyCnDI,EAAUL,EAAeG,EAAMC,EAAQF,EAAS,IAAK,4BAA6B,CAAE,EAKxFH,EAAO,QAAUM,IC5EjB,IAAAC,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,IA8BVC,EAAUD,EAAQ,EAKtBD,EAAO,QAAUE,ICKjB,IAAIC,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAU,IAKdF,EAAaC,EAAM,UAAWC,CAAQ,EAKtC,OAAO,QAAUD", - "names": ["require_factory", "__commonJSMin", "exports", "module", "binaryFactory", "dtypes", "defaults", "base", "DTYPES", "factory", "require_main", "__commonJSMin", "exports", "module", "factory", "uniform", "setReadOnly", "main", "factory"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index af6976c..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,198 +0,0 @@ - -{{alias}}( len, a, b[, options] ) - Returns an array containing pseudorandom numbers drawn from a continuous - uniform distribution. - - Parameters - ---------- - len: integer - Output array length. - - a: number - Minimum support. - - b: number - Maximum support. - - 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 ) - - - -{{alias}}.assign( a, b, out ) - Fills an array with pseudorandom numbers drawn from a continuous uniform - distribution. - - Parameters - ---------- - a: number - Minimum support. - - b: number - Maximum support. - - 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, x ) - - > var bool = ( out === x ) - true - - -{{alias}}.factory( [a, b, ][options] ) - Returns a function for creating arrays containing pseudorandom numbers drawn - from a continuous uniform 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. - - 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 ) - - - // Provide distribution parameters: - > fcn = {{alias}}.factory( 2.0, 5.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 ) - - - // Get a copy of the current state: - > var state = {{alias}}.state - - - > out = {{alias}}( 3, 2.0, 5.0 ) - - > out = {{alias}}( 3, 2.0, 5.0 ) - - - // Set the state: - > {{alias}}.state = state; - - // Regenerate a previous array: - > out = {{alias}}( 3, 2.0, 5.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 9e8939e..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,409 +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. -*/ - -import zeros = require( '@stdlib/array-zeros' ); -import random = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - random( 10, 2.0, 5.0 ); // $ExpectType RandomArray - random( 10, 2.0, 5.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 ); // $ExpectError - random( true, 2.0, 5.0 ); // $ExpectError - random( false, 2.0, 5.0 ); // $ExpectError - random( null, 2.0, 5.0 ); // $ExpectError - random( [], 2.0, 5.0 ); // $ExpectError - random( {}, 2.0, 5.0 ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - random( '5', 2.0, 5.0, {} ); // $ExpectError - random( true, 2.0, 5.0, {} ); // $ExpectError - random( false, 2.0, 5.0, {} ); // $ExpectError - random( null, 2.0, 5.0, {} ); // $ExpectError - random( [], 2.0, 5.0, {} ); // $ExpectError - random( {}, 2.0, 5.0, {} ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.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 ); // $ExpectError - random( 10, true, 5.0 ); // $ExpectError - random( 10, false, 5.0 ); // $ExpectError - random( 10, null, 5.0 ); // $ExpectError - random( 10, [], 5.0 ); // $ExpectError - random( 10, {}, 5.0 ); // $ExpectError - random( 10, ( x: number ): number => x, 5.0 ); // $ExpectError - - random( 10, '5', 5.0, {} ); // $ExpectError - random( 10, true, 5.0, {} ); // $ExpectError - random( 10, false, 5.0, {} ); // $ExpectError - random( 10, null, 5.0, {} ); // $ExpectError - random( 10, [], 5.0, {} ); // $ExpectError - random( 10, {}, 5.0, {} ); // $ExpectError - random( 10, ( x: number ): number => x, 5.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' ); // $ExpectError - random( 10, 2.0, true ); // $ExpectError - random( 10, 2.0, false ); // $ExpectError - random( 10, 2.0, null ); // $ExpectError - random( 10, 2.0, [] ); // $ExpectError - random( 10, 2.0, {} ); // $ExpectError - random( 10, 2.0, ( x: number ): number => x ); // $ExpectError - - random( 10, 2.0, '5', {} ); // $ExpectError - random( 10, 2.0, true, {} ); // $ExpectError - random( 10, 2.0, false, {} ); // $ExpectError - random( 10, 2.0, null, {} ); // $ExpectError - random( 10, 2.0, [], {} ); // $ExpectError - random( 10, 2.0, {}, {} ); // $ExpectError - random( 10, 2.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, '5' ); // $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, [] ); // $ExpectError - random( 10, 2.0, 5.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, { 'dtype': 123 } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': null } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - random( 10, 2.0, 5.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 -} - -// Attached to the main export is an `assign` method which returns an array... -{ - const x = zeros( 10, 'float64' ); - - random.assign( 2.0, 5.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, x ); // $ExpectError - random.assign( true, 5.0, x ); // $ExpectError - random.assign( false, 5.0, x ); // $ExpectError - random.assign( null, 5.0, x ); // $ExpectError - random.assign( [], 5.0, x ); // $ExpectError - random.assign( {}, 5.0, x ); // $ExpectError - random.assign( ( x: number ): number => x, 5.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', x ); // $ExpectError - random.assign( 2.0, true, x ); // $ExpectError - random.assign( 2.0, false, x ); // $ExpectError - random.assign( 2.0, null, x ); // $ExpectError - random.assign( 2.0, [], x ); // $ExpectError - random.assign( 2.0, {}, x ); // $ExpectError - random.assign( 2.0, ( x: number ): number => x, x ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid output array... -{ - random.assign( 2.0, 5.0, '5' ); // $ExpectError - random.assign( 2.0, 5.0, 5 ); // $ExpectError - random.assign( 2.0, 5.0, true ); // $ExpectError - random.assign( 2.0, 5.0, false ); // $ExpectError - random.assign( 2.0, 5.0, null ); // $ExpectError - random.assign( 2.0, 5.0, {} ); // $ExpectError - random.assign( 2.0, 5.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const 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 -} - -// Attached to main export is a `factory` method which returns a function... -{ - random.factory( 2.0, 5.0 ); // $ExpectType UnaryFunction - random.factory( 2.0, 5.0, { 'copy': false } ); // $ExpectType UnaryFunction - - random.factory(); // $ExpectType TernaryFunction - random.factory( { 'copy': false } ); // $ExpectType TernaryFunction -} - -// The `factory` method returns a function which returns an array... -{ - const fcn1 = random.factory( 2.0, 5.0 ); - fcn1( 10 ); // $ExpectType RandomArray - - const fcn2 = random.factory(); - fcn2( 10, 2.0, 5.0 ); // $ExpectType RandomArray -} - -// The compiler throws an error if the `factory` method is provided invalid arguments... -{ - random.factory( '5', 5.0 ); // $ExpectError - random.factory( true, 5.0 ); // $ExpectError - random.factory( false, 5.0 ); // $ExpectError - random.factory( [], 5.0 ); // $ExpectError - random.factory( {}, 5.0 ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0 ); // $ExpectError - - random.factory( '5', 5.0, {} ); // $ExpectError - random.factory( true, 5.0, {} ); // $ExpectError - random.factory( false, 5.0, {} ); // $ExpectError - random.factory( [], 5.0, {} ); // $ExpectError - random.factory( {}, 5.0, {} ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0, {} ); // $ExpectError - - random.factory( 2.0, '5' ); // $ExpectError - random.factory( 2.0, true ); // $ExpectError - random.factory( 2.0, false ); // $ExpectError - random.factory( 2.0, [] ); // $ExpectError - random.factory( 2.0, {} ); // $ExpectError - random.factory( 2.0, ( x: number ): number => x ); // $ExpectError - - random.factory( 2.0, '5', {} ); // $ExpectError - random.factory( 2.0, true, {} ); // $ExpectError - random.factory( 2.0, false, {} ); // $ExpectError - random.factory( 2.0, [], {} ); // $ExpectError - random.factory( 2.0, {}, {} ); // $ExpectError - random.factory( 2.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, 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, { 'prng': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'seed': true } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': [ 'a' ] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'state': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': {} } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': true } ); // $ExpectError - random.factory( 2.0, 5.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, { 'copy': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'dtype': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - random.factory( 2.0, 5.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, {}, {} ); // $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 ); - 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 ); // $ExpectError - fcn2( false, 2.0, 5.0 ); // $ExpectError - fcn2( '5', 2.0, 5.0 ); // $ExpectError - fcn2( [], 2.0, 5.0 ); // $ExpectError - fcn2( {}, 2.0, 5.0 ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - fcn2( true, 2.0, 5.0, {} ); // $ExpectError - fcn2( false, 2.0, 5.0, {} ); // $ExpectError - fcn2( '5', 2.0, 5.0, {} ); // $ExpectError - fcn2( [], 2.0, 5.0, {} ); // $ExpectError - fcn2( {}, 2.0, 5.0, {} ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0, {} ); // $ExpectError - - fcn2( 10, true, 5.0 ); // $ExpectError - fcn2( 10, false, 5.0 ); // $ExpectError - fcn2( 10, '5', 5.0 ); // $ExpectError - fcn2( 10, [], 5.0 ); // $ExpectError - fcn2( 10, {}, 5.0 ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0 ); // $ExpectError - - fcn2( 10, true, 5.0, {} ); // $ExpectError - fcn2( 10, false, 5.0, {} ); // $ExpectError - fcn2( 10, '5', 5.0, {} ); // $ExpectError - fcn2( 10, [], 5.0, {} ); // $ExpectError - fcn2( 10, {}, 5.0, {} ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0, {} ); // $ExpectError - - fcn2( 10, 2.0, true ); // $ExpectError - fcn2( 10, 2.0, false ); // $ExpectError - fcn2( 10, 2.0, '5' ); // $ExpectError - fcn2( 10, 2.0, [] ); // $ExpectError - fcn2( 10, 2.0, {} ); // $ExpectError - fcn2( 10, 2.0, ( x: number ): number => x ); // $ExpectError - - fcn2( 10, 2.0, true, {} ); // $ExpectError - fcn2( 10, 2.0, false, {} ); // $ExpectError - fcn2( 10, 2.0, '5', {} ); // $ExpectError - fcn2( 10, 2.0, [], {} ); // $ExpectError - fcn2( 10, 2.0, {}, {} ); // $ExpectError - fcn2( 10, 2.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, { 'dtype': 123 } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': null } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError - - const fcn2 = random.factory( 2.0, 5.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 ); - fcn1(); // $ExpectError - fcn1( 1, 1, 1 ); // $ExpectError - - const fcn2 = random.factory(); - fcn2(); // $ExpectError - fcn2( 1 ); // $ExpectError - fcn2( 1, 1, 1, 1 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index c485546..0000000 --- a/examples/index.js +++ /dev/null @@ -1,48 +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'; - -var logEach = require( '@stdlib/console-log-each' ); -var uniform = require( './../lib' ); - -// Create a function for generating random arrays originating from the same state: -var random = uniform.factory( 2.0, 5.0, { - 'state': uniform.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 = uniform.factory( 2.0, 5.0, { - 'state': uniform.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 9a727e8..2935269 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..93a60b0 --- /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-binary-factory@v0.2.1-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtypes@v0.2.1-esm/index.mjs";import r 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-uniform@v0.2.0-esm/index.mjs";var d=e(n,s("real_floating_point_and_generic"),r.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..ab36cb6 --- /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) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 binaryFactory from '@stdlib/random-array-tools-binary-factory';\nimport dtypes from '@stdlib/array-dtypes';\nimport defaults from '@stdlib/array-defaults';\nimport base from '@stdlib/random-base-uniform';\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 continuous uniform distribution.\n*\n* @name factory\n* @type {Function}\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\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} 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 uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10 );\n* // returns \n*\n* @example\n* var uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar factory = binaryFactory( 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) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution.\n*\n* @name uniform\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\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 = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar uniform = factory();\n\n\n// EXPORTS //\n\nexport default uniform;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution.\n*\n* @module @stdlib/random-array-uniform\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.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","binaryFactory","base","dtypes","defaults","get","uniform","setReadOnly","main"],"mappings":";;kfA8BA,IAyCIA,EAAUC,EAAeC,EAzChBC,EAAQ,mCAyCsBC,EAASC,IAAK,+BCnBrDC,EAAUN,ICiBdO,EAAAC,EAAA,UAAAR"} \ No newline at end of file diff --git a/lib/factory.js b/lib/factory.js deleted file mode 100644 index 79da171..0000000 --- a/lib/factory.js +++ /dev/null @@ -1,77 +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 binaryFactory = require( '@stdlib/random-array-tools-binary-factory' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var defaults = require( '@stdlib/array-defaults' ); -var base = require( '@stdlib/random-base-uniform' ); - - -// VARIABLES // - -var DTYPES = dtypes( 'real_floating_point_and_generic' ); - - -// MAIN // - -/** -* Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution. -* -* @name factory -* @type {Function} -* @param {number} [a] - minimum support -* @param {number} [b] - maximum support -* @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} 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 uniform = factory( 2.0, 5.0 ); -* // returns -* -* var arr = uniform( 10 ); -* // returns -* -* @example -* var uniform = factory( 2.0, 5.0 ); -* // returns -* -* var arr = uniform( 10, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -var factory = binaryFactory( 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 3376c12..0000000 --- a/lib/index.js +++ /dev/null @@ -1,77 +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'; - -/** -* Create an array containing pseudorandom numbers drawn from a continuous uniform distribution. -* -* @module @stdlib/random-array-uniform -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var arr = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var arr = uniform( 10, 2.0, 5.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var rand = uniform.factory( 2.0, 5.0 ); -* // returns -* -* var arr = rand( 10 ); -* // returns -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var rand = uniform.factory( 2.0, 5.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 f93ef8f..0000000 --- a/lib/main.js +++ /dev/null @@ -1,58 +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 factory = require( './factory.js' ); - - -// MAIN // - -/** -* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution. -* -* @name uniform -* @type {Function} -* @param {NonNegativeInteger} len - array length -* @param {number} a - minimum support -* @param {number} b - maximum support -* @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 = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var arr = uniform( 10, 2.0, 5.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -var uniform = factory(); - - -// EXPORTS // - -module.exports = uniform; diff --git a/package.json b/package.json index 06cafae..78b1595 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 continuous uniform 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-binary-factory": "^0.2.1", - "@stdlib/random-base-uniform": "^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..17d96ac --- /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 14d34c7..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, 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, 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, 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, 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 765abb1..0000000 --- a/test/test.factory.js +++ /dev/null @@ -1,1261 +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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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, 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, { - '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, { - '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, { - '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, { - '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, { - '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, { - '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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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 ); - - 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 ); - - 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, { - '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 ); - - 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 ); - 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 ); - - 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 ); - - 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 ); - - 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 ); - - 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, { - '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 ); - - 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, { - '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 ); - - 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, { - '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 ); - - 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, { - '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 ); - - 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, { - '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, { - '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 ); - - // 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, { - '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 ); - - // 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, { - '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 ); - - 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, { - 'prng': randu.normalized - }); - - randu = minstd.factory({ - 'seed': seed - }); - random2 = factory( 2.0, 5.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 ); - arr2 = random2( 10, 2.0, 5.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 4e0f74d..0000000 --- a/test/test.js +++ /dev/null @@ -1,74 +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 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 faf9d84..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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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, 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, { - '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 ); - - 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, { - '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, { - '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, { - '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 ); - } - // Capture the current state: - state = random.state; - - // Move to a future state... - arr = random( 10, 2.0, 5.0 ); - for ( i = 0; i < 100; i++ ) { - random( 2, 2.0, 5.0 ); - } - // Set the state: - random.state = state; - - // Replay previously generated values: - t.deepEqual( random( 10, 2.0, 5.0 ), arr, 'returns expected value' ); - - t.end(); -}); From 9b66763946b24e1490a0f012280b4661fab53f25 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 25 Feb 2024 22:26:20 +0000 Subject: [PATCH 66/82] 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 1074d25..165011e 100644 --- a/README.md +++ b/README.md @@ -42,13 +42,13 @@ limitations under the License. ## Usage ```javascript -import uniform from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-uniform@esm/index.mjs'; +import uniform from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-uniform@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-uniform@esm/index.mjs'; +import { factory } from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-uniform@v0.2.1-esm/index.mjs'; ``` #### uniform( len, a, b\[, options] ) @@ -343,7 +343,7 @@ var sz = random.byteLength; - - - - From 793a1ac528edf931800682cc6ec60a364ff14108 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 1 Mar 2024 14:43:16 +0000 Subject: [PATCH 70/82] 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 | 69 +- 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 | 198 - docs/types/test.ts | 409 -- examples/index.js | 48 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/factory.js | 77 - lib/index.js | 77 - lib/main.js | 58 - package.json | 71 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 118 - test/test.factory.js | 1261 ------ test/test.js | 74 - test/test.main.js | 244 -- 55 files changed, 4884 insertions(+), 6816 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 7ac8ddf..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-03-01T06:26:40.918Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index c4ab52b..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/uniform) 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 5097056..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/uniform) 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 31ea6a7..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: '33 9 * * 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,19 +468,19 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/random-array-uniform/main/LICENSE -[@stdlib/random/base/uniform]: https://github.com/stdlib-js/random-base-uniform +[@stdlib/random/base/uniform]: https://github.com/stdlib-js/random-base-uniform/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 -[@stdlib/random/array/discrete-uniform]: https://github.com/stdlib-js/random-array-discrete-uniform +[@stdlib/random/array/discrete-uniform]: https://github.com/stdlib-js/random-array-discrete-uniform/tree/esm -[@stdlib/random/strided/uniform]: https://github.com/stdlib-js/random-strided-uniform +[@stdlib/random/strided/uniform]: https://github.com/stdlib-js/random-strided-uniform/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 4923816..0000000 --- a/benchmark/benchmark.float32.assign.js +++ /dev/null @@ -1,97 +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 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, 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 dea0644..0000000 --- a/benchmark/benchmark.float32.factory.js +++ /dev/null @@ -1,96 +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 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, { - '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 4249752..0000000 --- a/benchmark/benchmark.float32.js +++ /dev/null @@ -1,98 +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 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, 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 8cf1538..0000000 --- a/benchmark/benchmark.float64.assign.js +++ /dev/null @@ -1,97 +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 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, 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 f352bca..0000000 --- a/benchmark/benchmark.float64.factory.js +++ /dev/null @@ -1,96 +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 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, { - '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 e176e0a..0000000 --- a/benchmark/benchmark.float64.js +++ /dev/null @@ -1,98 +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 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, 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 6038ee7..0000000 --- a/benchmark/benchmark.generic.assign.js +++ /dev/null @@ -1,97 +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 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, 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 6a6bddc..0000000 --- a/benchmark/benchmark.generic.factory.js +++ /dev/null @@ -1,96 +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 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, { - '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 b6bdcfd..0000000 --- a/benchmark/benchmark.generic.js +++ /dev/null @@ -1,98 +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 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, 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 5a79fd6..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/uniform" -%% click B href "https://github.com/stdlib-js/random-array-uniform/tree/main" -%% click C href "https://github.com/stdlib-js/random-array-uniform/tree/production" -%% click D href "https://github.com/stdlib-js/random-array-uniform/tree/esm" -%% click E href "https://github.com/stdlib-js/random-array-uniform/tree/deno" -%% click F href "https://github.com/stdlib-js/random-array-uniform/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/uniform -[production-url]: https://github.com/stdlib-js/random-array-uniform/tree/production -[deno-url]: https://github.com/stdlib-js/random-array-uniform/tree/deno -[deno-readme]: https://github.com/stdlib-js/random-array-uniform/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/random-array-uniform/tree/umd -[umd-readme]: https://github.com/stdlib-js/random-array-uniform/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/random-array-uniform/tree/esm -[esm-readme]: https://github.com/stdlib-js/random-array-uniform/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 f2a679f..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import uniform from '../docs/types/index'; -export = uniform; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index f49a668..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var a=function(u,r){return function(){return r||u((r={exports:{}}).exports,r),r.exports}};var e=a(function(x,t){ -var v=require('@stdlib/random-array-tools-binary-factory/dist'),n=require('@stdlib/array-dtypes/dist'),c=require('@stdlib/array-defaults/dist'),y=require('@stdlib/random-base-uniform/dist'),f=n("real_floating_point_and_generic"),q=v(y,f,c.get("dtypes.real_floating_point"));t.exports=q -});var s=a(function(b,i){ -var p=e(),l=p();i.exports=l -});var _=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),o=s(),d=e();_(o,"factory",d);module.exports=o; -/** @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 815b1ac..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) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 binaryFactory = require( '@stdlib/random-array-tools-binary-factory' );\nvar dtypes = require( '@stdlib/array-dtypes' );\nvar defaults = require( '@stdlib/array-defaults' );\nvar base = require( '@stdlib/random-base-uniform' );\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 continuous uniform distribution.\n*\n* @name factory\n* @type {Function}\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\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} 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 uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10 );\n* // returns \n*\n* @example\n* var uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar factory = binaryFactory( 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) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution.\n*\n* @name uniform\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\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 = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar uniform = factory();\n\n\n// EXPORTS //\n\nmodule.exports = uniform;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution.\n*\n* @module @stdlib/random-array-uniform\n*\n* @example\n* var uniform = require( '@stdlib/random-array-uniform' );\n*\n* var arr = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var uniform = require( '@stdlib/random-array-uniform' );\n*\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* var uniform = require( '@stdlib/random-array-uniform' );\n*\n* var rand = uniform.factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* var uniform = require( '@stdlib/random-array-uniform' );\n*\n* var rand = uniform.factory( 2.0, 5.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,EAAgB,QAAS,2CAA4C,EACrEC,EAAS,QAAS,sBAAuB,EACzCC,EAAW,QAAS,wBAAyB,EAC7CC,EAAO,QAAS,6BAA8B,EAK9CC,EAASH,EAAQ,iCAAkC,EAyCnDI,EAAUL,EAAeG,EAAMC,EAAQF,EAAS,IAAK,4BAA6B,CAAE,EAKxFH,EAAO,QAAUM,IC5EjB,IAAAC,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,IA8BVC,EAAUD,EAAQ,EAKtBD,EAAO,QAAUE,ICKjB,IAAIC,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAU,IAKdF,EAAaC,EAAM,UAAWC,CAAQ,EAKtC,OAAO,QAAUD", - "names": ["require_factory", "__commonJSMin", "exports", "module", "binaryFactory", "dtypes", "defaults", "base", "DTYPES", "factory", "require_main", "__commonJSMin", "exports", "module", "factory", "uniform", "setReadOnly", "main", "factory"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index af6976c..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,198 +0,0 @@ - -{{alias}}( len, a, b[, options] ) - Returns an array containing pseudorandom numbers drawn from a continuous - uniform distribution. - - Parameters - ---------- - len: integer - Output array length. - - a: number - Minimum support. - - b: number - Maximum support. - - 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 ) - - - -{{alias}}.assign( a, b, out ) - Fills an array with pseudorandom numbers drawn from a continuous uniform - distribution. - - Parameters - ---------- - a: number - Minimum support. - - b: number - Maximum support. - - 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, x ) - - > var bool = ( out === x ) - true - - -{{alias}}.factory( [a, b, ][options] ) - Returns a function for creating arrays containing pseudorandom numbers drawn - from a continuous uniform 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. - - 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 ) - - - // Provide distribution parameters: - > fcn = {{alias}}.factory( 2.0, 5.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 ) - - - // Get a copy of the current state: - > var state = {{alias}}.state - - - > out = {{alias}}( 3, 2.0, 5.0 ) - - > out = {{alias}}( 3, 2.0, 5.0 ) - - - // Set the state: - > {{alias}}.state = state; - - // Regenerate a previous array: - > out = {{alias}}( 3, 2.0, 5.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 9e8939e..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,409 +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. -*/ - -import zeros = require( '@stdlib/array-zeros' ); -import random = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - random( 10, 2.0, 5.0 ); // $ExpectType RandomArray - random( 10, 2.0, 5.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 ); // $ExpectError - random( true, 2.0, 5.0 ); // $ExpectError - random( false, 2.0, 5.0 ); // $ExpectError - random( null, 2.0, 5.0 ); // $ExpectError - random( [], 2.0, 5.0 ); // $ExpectError - random( {}, 2.0, 5.0 ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - random( '5', 2.0, 5.0, {} ); // $ExpectError - random( true, 2.0, 5.0, {} ); // $ExpectError - random( false, 2.0, 5.0, {} ); // $ExpectError - random( null, 2.0, 5.0, {} ); // $ExpectError - random( [], 2.0, 5.0, {} ); // $ExpectError - random( {}, 2.0, 5.0, {} ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.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 ); // $ExpectError - random( 10, true, 5.0 ); // $ExpectError - random( 10, false, 5.0 ); // $ExpectError - random( 10, null, 5.0 ); // $ExpectError - random( 10, [], 5.0 ); // $ExpectError - random( 10, {}, 5.0 ); // $ExpectError - random( 10, ( x: number ): number => x, 5.0 ); // $ExpectError - - random( 10, '5', 5.0, {} ); // $ExpectError - random( 10, true, 5.0, {} ); // $ExpectError - random( 10, false, 5.0, {} ); // $ExpectError - random( 10, null, 5.0, {} ); // $ExpectError - random( 10, [], 5.0, {} ); // $ExpectError - random( 10, {}, 5.0, {} ); // $ExpectError - random( 10, ( x: number ): number => x, 5.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' ); // $ExpectError - random( 10, 2.0, true ); // $ExpectError - random( 10, 2.0, false ); // $ExpectError - random( 10, 2.0, null ); // $ExpectError - random( 10, 2.0, [] ); // $ExpectError - random( 10, 2.0, {} ); // $ExpectError - random( 10, 2.0, ( x: number ): number => x ); // $ExpectError - - random( 10, 2.0, '5', {} ); // $ExpectError - random( 10, 2.0, true, {} ); // $ExpectError - random( 10, 2.0, false, {} ); // $ExpectError - random( 10, 2.0, null, {} ); // $ExpectError - random( 10, 2.0, [], {} ); // $ExpectError - random( 10, 2.0, {}, {} ); // $ExpectError - random( 10, 2.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, '5' ); // $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, [] ); // $ExpectError - random( 10, 2.0, 5.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, { 'dtype': 123 } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': null } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - random( 10, 2.0, 5.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 -} - -// Attached to the main export is an `assign` method which returns an array... -{ - const x = zeros( 10, 'float64' ); - - random.assign( 2.0, 5.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, x ); // $ExpectError - random.assign( true, 5.0, x ); // $ExpectError - random.assign( false, 5.0, x ); // $ExpectError - random.assign( null, 5.0, x ); // $ExpectError - random.assign( [], 5.0, x ); // $ExpectError - random.assign( {}, 5.0, x ); // $ExpectError - random.assign( ( x: number ): number => x, 5.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', x ); // $ExpectError - random.assign( 2.0, true, x ); // $ExpectError - random.assign( 2.0, false, x ); // $ExpectError - random.assign( 2.0, null, x ); // $ExpectError - random.assign( 2.0, [], x ); // $ExpectError - random.assign( 2.0, {}, x ); // $ExpectError - random.assign( 2.0, ( x: number ): number => x, x ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid output array... -{ - random.assign( 2.0, 5.0, '5' ); // $ExpectError - random.assign( 2.0, 5.0, 5 ); // $ExpectError - random.assign( 2.0, 5.0, true ); // $ExpectError - random.assign( 2.0, 5.0, false ); // $ExpectError - random.assign( 2.0, 5.0, null ); // $ExpectError - random.assign( 2.0, 5.0, {} ); // $ExpectError - random.assign( 2.0, 5.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const 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 -} - -// Attached to main export is a `factory` method which returns a function... -{ - random.factory( 2.0, 5.0 ); // $ExpectType UnaryFunction - random.factory( 2.0, 5.0, { 'copy': false } ); // $ExpectType UnaryFunction - - random.factory(); // $ExpectType TernaryFunction - random.factory( { 'copy': false } ); // $ExpectType TernaryFunction -} - -// The `factory` method returns a function which returns an array... -{ - const fcn1 = random.factory( 2.0, 5.0 ); - fcn1( 10 ); // $ExpectType RandomArray - - const fcn2 = random.factory(); - fcn2( 10, 2.0, 5.0 ); // $ExpectType RandomArray -} - -// The compiler throws an error if the `factory` method is provided invalid arguments... -{ - random.factory( '5', 5.0 ); // $ExpectError - random.factory( true, 5.0 ); // $ExpectError - random.factory( false, 5.0 ); // $ExpectError - random.factory( [], 5.0 ); // $ExpectError - random.factory( {}, 5.0 ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0 ); // $ExpectError - - random.factory( '5', 5.0, {} ); // $ExpectError - random.factory( true, 5.0, {} ); // $ExpectError - random.factory( false, 5.0, {} ); // $ExpectError - random.factory( [], 5.0, {} ); // $ExpectError - random.factory( {}, 5.0, {} ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0, {} ); // $ExpectError - - random.factory( 2.0, '5' ); // $ExpectError - random.factory( 2.0, true ); // $ExpectError - random.factory( 2.0, false ); // $ExpectError - random.factory( 2.0, [] ); // $ExpectError - random.factory( 2.0, {} ); // $ExpectError - random.factory( 2.0, ( x: number ): number => x ); // $ExpectError - - random.factory( 2.0, '5', {} ); // $ExpectError - random.factory( 2.0, true, {} ); // $ExpectError - random.factory( 2.0, false, {} ); // $ExpectError - random.factory( 2.0, [], {} ); // $ExpectError - random.factory( 2.0, {}, {} ); // $ExpectError - random.factory( 2.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, 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, { 'prng': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'seed': true } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': [ 'a' ] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'state': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': {} } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': true } ); // $ExpectError - random.factory( 2.0, 5.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, { 'copy': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'dtype': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - random.factory( 2.0, 5.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, {}, {} ); // $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 ); - 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 ); // $ExpectError - fcn2( false, 2.0, 5.0 ); // $ExpectError - fcn2( '5', 2.0, 5.0 ); // $ExpectError - fcn2( [], 2.0, 5.0 ); // $ExpectError - fcn2( {}, 2.0, 5.0 ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - fcn2( true, 2.0, 5.0, {} ); // $ExpectError - fcn2( false, 2.0, 5.0, {} ); // $ExpectError - fcn2( '5', 2.0, 5.0, {} ); // $ExpectError - fcn2( [], 2.0, 5.0, {} ); // $ExpectError - fcn2( {}, 2.0, 5.0, {} ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0, {} ); // $ExpectError - - fcn2( 10, true, 5.0 ); // $ExpectError - fcn2( 10, false, 5.0 ); // $ExpectError - fcn2( 10, '5', 5.0 ); // $ExpectError - fcn2( 10, [], 5.0 ); // $ExpectError - fcn2( 10, {}, 5.0 ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0 ); // $ExpectError - - fcn2( 10, true, 5.0, {} ); // $ExpectError - fcn2( 10, false, 5.0, {} ); // $ExpectError - fcn2( 10, '5', 5.0, {} ); // $ExpectError - fcn2( 10, [], 5.0, {} ); // $ExpectError - fcn2( 10, {}, 5.0, {} ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0, {} ); // $ExpectError - - fcn2( 10, 2.0, true ); // $ExpectError - fcn2( 10, 2.0, false ); // $ExpectError - fcn2( 10, 2.0, '5' ); // $ExpectError - fcn2( 10, 2.0, [] ); // $ExpectError - fcn2( 10, 2.0, {} ); // $ExpectError - fcn2( 10, 2.0, ( x: number ): number => x ); // $ExpectError - - fcn2( 10, 2.0, true, {} ); // $ExpectError - fcn2( 10, 2.0, false, {} ); // $ExpectError - fcn2( 10, 2.0, '5', {} ); // $ExpectError - fcn2( 10, 2.0, [], {} ); // $ExpectError - fcn2( 10, 2.0, {}, {} ); // $ExpectError - fcn2( 10, 2.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, { 'dtype': 123 } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': null } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError - - const fcn2 = random.factory( 2.0, 5.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 ); - fcn1(); // $ExpectError - fcn1( 1, 1, 1 ); // $ExpectError - - const fcn2 = random.factory(); - fcn2(); // $ExpectError - fcn2( 1 ); // $ExpectError - fcn2( 1, 1, 1, 1 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index c485546..0000000 --- a/examples/index.js +++ /dev/null @@ -1,48 +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'; - -var logEach = require( '@stdlib/console-log-each' ); -var uniform = require( './../lib' ); - -// Create a function for generating random arrays originating from the same state: -var random = uniform.factory( 2.0, 5.0, { - 'state': uniform.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 = uniform.factory( 2.0, 5.0, { - 'state': uniform.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 9a727e8..2935269 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..02f69bc --- /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-binary-factory@v0.2.1-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtypes@v0.2.1-esm/index.mjs";import r 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-uniform@v0.2.1-esm/index.mjs";var d=e(n,s("real_floating_point_and_generic"),r.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..ab36cb6 --- /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) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 binaryFactory from '@stdlib/random-array-tools-binary-factory';\nimport dtypes from '@stdlib/array-dtypes';\nimport defaults from '@stdlib/array-defaults';\nimport base from '@stdlib/random-base-uniform';\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 continuous uniform distribution.\n*\n* @name factory\n* @type {Function}\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\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} 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 uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10 );\n* // returns \n*\n* @example\n* var uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar factory = binaryFactory( 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) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution.\n*\n* @name uniform\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\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 = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar uniform = factory();\n\n\n// EXPORTS //\n\nexport default uniform;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution.\n*\n* @module @stdlib/random-array-uniform\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.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","binaryFactory","base","dtypes","defaults","get","uniform","setReadOnly","main"],"mappings":";;kfA8BA,IAyCIA,EAAUC,EAAeC,EAzChBC,EAAQ,mCAyCsBC,EAASC,IAAK,+BCnBrDC,EAAUN,ICiBdO,EAAAC,EAAA,UAAAR"} \ No newline at end of file diff --git a/lib/factory.js b/lib/factory.js deleted file mode 100644 index 79da171..0000000 --- a/lib/factory.js +++ /dev/null @@ -1,77 +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 binaryFactory = require( '@stdlib/random-array-tools-binary-factory' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var defaults = require( '@stdlib/array-defaults' ); -var base = require( '@stdlib/random-base-uniform' ); - - -// VARIABLES // - -var DTYPES = dtypes( 'real_floating_point_and_generic' ); - - -// MAIN // - -/** -* Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution. -* -* @name factory -* @type {Function} -* @param {number} [a] - minimum support -* @param {number} [b] - maximum support -* @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} 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 uniform = factory( 2.0, 5.0 ); -* // returns -* -* var arr = uniform( 10 ); -* // returns -* -* @example -* var uniform = factory( 2.0, 5.0 ); -* // returns -* -* var arr = uniform( 10, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -var factory = binaryFactory( 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 3376c12..0000000 --- a/lib/index.js +++ /dev/null @@ -1,77 +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'; - -/** -* Create an array containing pseudorandom numbers drawn from a continuous uniform distribution. -* -* @module @stdlib/random-array-uniform -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var arr = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var arr = uniform( 10, 2.0, 5.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var rand = uniform.factory( 2.0, 5.0 ); -* // returns -* -* var arr = rand( 10 ); -* // returns -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var rand = uniform.factory( 2.0, 5.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 f93ef8f..0000000 --- a/lib/main.js +++ /dev/null @@ -1,58 +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 factory = require( './factory.js' ); - - -// MAIN // - -/** -* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution. -* -* @name uniform -* @type {Function} -* @param {NonNegativeInteger} len - array length -* @param {number} a - minimum support -* @param {number} b - maximum support -* @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 = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var arr = uniform( 10, 2.0, 5.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -var uniform = factory(); - - -// EXPORTS // - -module.exports = uniform; diff --git a/package.json b/package.json index 422e16f..78b1595 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 continuous uniform 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-binary-factory": "^0.2.1", - "@stdlib/random-base-uniform": "^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..8509c12 --- /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 14d34c7..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, 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, 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, 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, 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 765abb1..0000000 --- a/test/test.factory.js +++ /dev/null @@ -1,1261 +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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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, 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, { - '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, { - '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, { - '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, { - '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, { - '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, { - '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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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 ); - - 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 ); - - 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, { - '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 ); - - 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 ); - 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 ); - - 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 ); - - 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 ); - - 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 ); - - 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, { - '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 ); - - 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, { - '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 ); - - 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, { - '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 ); - - 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, { - '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 ); - - 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, { - '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, { - '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 ); - - // 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, { - '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 ); - - // 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, { - '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 ); - - 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, { - 'prng': randu.normalized - }); - - randu = minstd.factory({ - 'seed': seed - }); - random2 = factory( 2.0, 5.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 ); - arr2 = random2( 10, 2.0, 5.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 4e0f74d..0000000 --- a/test/test.js +++ /dev/null @@ -1,74 +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 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 faf9d84..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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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, 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, { - '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 ); - - 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, { - '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, { - '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, { - '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 ); - } - // Capture the current state: - state = random.state; - - // Move to a future state... - arr = random( 10, 2.0, 5.0 ); - for ( i = 0; i < 100; i++ ) { - random( 2, 2.0, 5.0 ); - } - // Set the state: - random.state = state; - - // Replay previously generated values: - t.deepEqual( random( 10, 2.0, 5.0 ), arr, 'returns expected value' ); - - t.end(); -}); From 118f7bddbce0a0350222f1f81821d8bc3d71b949 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Apr 2024 08:09:34 +0000 Subject: [PATCH 71/82] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 5d1204a..422e16f 100644 --- a/package.json +++ b/package.json @@ -42,7 +42,8 @@ "@stdlib/random-array-tools-binary-factory": "^0.2.1", "@stdlib/random-base-uniform": "^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 4957b3ec7004c97e2a104e38e250425231dd5c6d Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Apr 2024 13:47:50 +0000 Subject: [PATCH 72/82] Remove files --- index.d.ts | 279 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5126 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 2935269..0000000 --- a/index.d.ts +++ /dev/null @@ -1,279 +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. -*/ - -// 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 continuous uniform distribution with pre-specified parameter values. -*/ -interface UnaryFunction extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform 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 continuous uniform distribution. - * - * @param out - output array - * @returns output array - */ - assign( out: RandomArray ): RandomArray; -} - -/** -* Interface for generating pseudorandom numbers drawn from a continuous uniform distribution without pre-specified parameter values. -*/ -interface TernaryFunction extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution. - * - * @param len - array length - * @param a - minimum support - * @param b - maximum support - * @param options - function options - * @returns output array - */ - ( len: number, a: number, b: number, options?: Options ): RandomArray; - - /** - * Fills an array with pseudorandom numbers drawn from a continuous uniform distribution. - * - * @param a - minimum support - * @param b - maximum support - * @param out - output array - * @returns output array - */ - assign( a: number, b: number, out: RandomArray ): RandomArray; -} - -/** -* Interface for generating pseudorandom numbers drawn from a continuous uniform distribution. -*/ -interface Random extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution. - * - * @param len - array length - * @param a - minimum support - * @param b - maximum support - * @param options - function options - * @returns output array - * - * @example - * var out = uniform( 10, 2.0, 5.0 ); - * // returns - */ - ( len: number, a: number, b: number, options?: Options ): RandomArray; - - /** - * Fills an array with pseudorandom numbers drawn from a continuous uniform distribution. - * - * @param a - minimum support - * @param b - maximum support - * @param out - output array - * @returns output array - * - * @example - * var zeros = require( '@stdlib/array-zeros' ); - * - * var x = zeros( 10, 'float64' ); - * // returns - * - * var out = uniform( 2.0, 5.0, out ); - * // returns - * - * var bool = ( out === x ); - * // returns true - */ - assign( a: number, b: number, out: RandomArray ): RandomArray; - - /** - * Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform 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 options - function options - * @throws must provide a valid state - * @returns function for creating arrays - * - * @example - * var random = uniform.factory( 2.0, 5.0 ); - * - * var out = random( 10 ); - * // returns - * - * @example - * var random = uniform.factory( 2.0, 5.0, { - * 'seed': 297 - * }); - * var out = random( 10 ); - * // returns - */ - factory( a: number, b: number, options?: FactoryOptions ): UnaryFunction; - - /** - * Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform 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 = uniform.factory(); - * - * var out = random( 10, 2.0, 5.0 ); - * // returns - * - * @example - * var random = uniform.factory({ - * 'seed': 297 - * }); - * var out = random( 10, 2.0, 5.0 ); - * // returns - */ - factory( options?: FactoryOptions ): TernaryFunction; -} - -/** -* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution. -* -* @param len - array length -* @param a - minimum support -* @param b - maximum support -* @param options - function options -* @returns output array -* -* @example -* var out = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var random = uniform.factory( 2.0, 5.0 ); -* -* var out = random( 10 ); -* // returns -*/ -declare var uniform: Random; - - -// EXPORTS // - -export = uniform; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 02f69bc..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-binary-factory@v0.2.1-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtypes@v0.2.1-esm/index.mjs";import r 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-uniform@v0.2.1-esm/index.mjs";var d=e(n,s("real_floating_point_and_generic"),r.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 ab36cb6..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) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 binaryFactory from '@stdlib/random-array-tools-binary-factory';\nimport dtypes from '@stdlib/array-dtypes';\nimport defaults from '@stdlib/array-defaults';\nimport base from '@stdlib/random-base-uniform';\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 continuous uniform distribution.\n*\n* @name factory\n* @type {Function}\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\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} 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 uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10 );\n* // returns \n*\n* @example\n* var uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar factory = binaryFactory( 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) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution.\n*\n* @name uniform\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\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 = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar uniform = factory();\n\n\n// EXPORTS //\n\nexport default uniform;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution.\n*\n* @module @stdlib/random-array-uniform\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.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","binaryFactory","base","dtypes","defaults","get","uniform","setReadOnly","main"],"mappings":";;kfA8BA,IAyCIA,EAAUC,EAAeC,EAzChBC,EAAQ,mCAyCsBC,EAASC,IAAK,+BCnBrDC,EAAUN,ICiBdO,EAAAC,EAAA,UAAAR"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 8509c12..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 94272940af70da5dc8d581f7e71db2e05e2bbfcd Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Apr 2024 13:48:05 +0000 Subject: [PATCH 73/82] 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 | 69 +- 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 | 198 - docs/types/test.ts | 409 -- examples/index.js | 48 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/factory.js | 77 - lib/index.js | 77 - lib/main.js | 58 - package.json | 71 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 118 - test/test.factory.js | 1261 ------ test/test.js | 74 - test/test.main.js | 244 -- 55 files changed, 4884 insertions(+), 6819 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 40a9055..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-04-01T05:39:54.227Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index c4ab52b..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/uniform) 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 5097056..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/uniform) 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 31ea6a7..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: '33 9 * * 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,19 +468,19 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/random-array-uniform/main/LICENSE -[@stdlib/random/base/uniform]: https://github.com/stdlib-js/random-base-uniform +[@stdlib/random/base/uniform]: https://github.com/stdlib-js/random-base-uniform/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 -[@stdlib/random/array/discrete-uniform]: https://github.com/stdlib-js/random-array-discrete-uniform +[@stdlib/random/array/discrete-uniform]: https://github.com/stdlib-js/random-array-discrete-uniform/tree/esm -[@stdlib/random/strided/uniform]: https://github.com/stdlib-js/random-strided-uniform +[@stdlib/random/strided/uniform]: https://github.com/stdlib-js/random-strided-uniform/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 4923816..0000000 --- a/benchmark/benchmark.float32.assign.js +++ /dev/null @@ -1,97 +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 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, 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 dea0644..0000000 --- a/benchmark/benchmark.float32.factory.js +++ /dev/null @@ -1,96 +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 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, { - '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 4249752..0000000 --- a/benchmark/benchmark.float32.js +++ /dev/null @@ -1,98 +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 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, 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 8cf1538..0000000 --- a/benchmark/benchmark.float64.assign.js +++ /dev/null @@ -1,97 +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 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, 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 f352bca..0000000 --- a/benchmark/benchmark.float64.factory.js +++ /dev/null @@ -1,96 +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 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, { - '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 e176e0a..0000000 --- a/benchmark/benchmark.float64.js +++ /dev/null @@ -1,98 +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 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, 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 6038ee7..0000000 --- a/benchmark/benchmark.generic.assign.js +++ /dev/null @@ -1,97 +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 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, 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 6a6bddc..0000000 --- a/benchmark/benchmark.generic.factory.js +++ /dev/null @@ -1,96 +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 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, { - '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 b6bdcfd..0000000 --- a/benchmark/benchmark.generic.js +++ /dev/null @@ -1,98 +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 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, 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 5a79fd6..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/uniform" -%% click B href "https://github.com/stdlib-js/random-array-uniform/tree/main" -%% click C href "https://github.com/stdlib-js/random-array-uniform/tree/production" -%% click D href "https://github.com/stdlib-js/random-array-uniform/tree/esm" -%% click E href "https://github.com/stdlib-js/random-array-uniform/tree/deno" -%% click F href "https://github.com/stdlib-js/random-array-uniform/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/uniform -[production-url]: https://github.com/stdlib-js/random-array-uniform/tree/production -[deno-url]: https://github.com/stdlib-js/random-array-uniform/tree/deno -[deno-readme]: https://github.com/stdlib-js/random-array-uniform/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/random-array-uniform/tree/umd -[umd-readme]: https://github.com/stdlib-js/random-array-uniform/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/random-array-uniform/tree/esm -[esm-readme]: https://github.com/stdlib-js/random-array-uniform/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 f2a679f..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import uniform from '../docs/types/index'; -export = uniform; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index f49a668..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var a=function(u,r){return function(){return r||u((r={exports:{}}).exports,r),r.exports}};var e=a(function(x,t){ -var v=require('@stdlib/random-array-tools-binary-factory/dist'),n=require('@stdlib/array-dtypes/dist'),c=require('@stdlib/array-defaults/dist'),y=require('@stdlib/random-base-uniform/dist'),f=n("real_floating_point_and_generic"),q=v(y,f,c.get("dtypes.real_floating_point"));t.exports=q -});var s=a(function(b,i){ -var p=e(),l=p();i.exports=l -});var _=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),o=s(),d=e();_(o,"factory",d);module.exports=o; -/** @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 815b1ac..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) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 binaryFactory = require( '@stdlib/random-array-tools-binary-factory' );\nvar dtypes = require( '@stdlib/array-dtypes' );\nvar defaults = require( '@stdlib/array-defaults' );\nvar base = require( '@stdlib/random-base-uniform' );\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 continuous uniform distribution.\n*\n* @name factory\n* @type {Function}\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\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} 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 uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10 );\n* // returns \n*\n* @example\n* var uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar factory = binaryFactory( 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) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution.\n*\n* @name uniform\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\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 = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar uniform = factory();\n\n\n// EXPORTS //\n\nmodule.exports = uniform;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution.\n*\n* @module @stdlib/random-array-uniform\n*\n* @example\n* var uniform = require( '@stdlib/random-array-uniform' );\n*\n* var arr = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var uniform = require( '@stdlib/random-array-uniform' );\n*\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* var uniform = require( '@stdlib/random-array-uniform' );\n*\n* var rand = uniform.factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* var uniform = require( '@stdlib/random-array-uniform' );\n*\n* var rand = uniform.factory( 2.0, 5.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,EAAgB,QAAS,2CAA4C,EACrEC,EAAS,QAAS,sBAAuB,EACzCC,EAAW,QAAS,wBAAyB,EAC7CC,EAAO,QAAS,6BAA8B,EAK9CC,EAASH,EAAQ,iCAAkC,EAyCnDI,EAAUL,EAAeG,EAAMC,EAAQF,EAAS,IAAK,4BAA6B,CAAE,EAKxFH,EAAO,QAAUM,IC5EjB,IAAAC,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,IA8BVC,EAAUD,EAAQ,EAKtBD,EAAO,QAAUE,ICKjB,IAAIC,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAU,IAKdF,EAAaC,EAAM,UAAWC,CAAQ,EAKtC,OAAO,QAAUD", - "names": ["require_factory", "__commonJSMin", "exports", "module", "binaryFactory", "dtypes", "defaults", "base", "DTYPES", "factory", "require_main", "__commonJSMin", "exports", "module", "factory", "uniform", "setReadOnly", "main", "factory"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index af6976c..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,198 +0,0 @@ - -{{alias}}( len, a, b[, options] ) - Returns an array containing pseudorandom numbers drawn from a continuous - uniform distribution. - - Parameters - ---------- - len: integer - Output array length. - - a: number - Minimum support. - - b: number - Maximum support. - - 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 ) - - - -{{alias}}.assign( a, b, out ) - Fills an array with pseudorandom numbers drawn from a continuous uniform - distribution. - - Parameters - ---------- - a: number - Minimum support. - - b: number - Maximum support. - - 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, x ) - - > var bool = ( out === x ) - true - - -{{alias}}.factory( [a, b, ][options] ) - Returns a function for creating arrays containing pseudorandom numbers drawn - from a continuous uniform 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. - - 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 ) - - - // Provide distribution parameters: - > fcn = {{alias}}.factory( 2.0, 5.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 ) - - - // Get a copy of the current state: - > var state = {{alias}}.state - - - > out = {{alias}}( 3, 2.0, 5.0 ) - - > out = {{alias}}( 3, 2.0, 5.0 ) - - - // Set the state: - > {{alias}}.state = state; - - // Regenerate a previous array: - > out = {{alias}}( 3, 2.0, 5.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 9e8939e..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,409 +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. -*/ - -import zeros = require( '@stdlib/array-zeros' ); -import random = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - random( 10, 2.0, 5.0 ); // $ExpectType RandomArray - random( 10, 2.0, 5.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 ); // $ExpectError - random( true, 2.0, 5.0 ); // $ExpectError - random( false, 2.0, 5.0 ); // $ExpectError - random( null, 2.0, 5.0 ); // $ExpectError - random( [], 2.0, 5.0 ); // $ExpectError - random( {}, 2.0, 5.0 ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - random( '5', 2.0, 5.0, {} ); // $ExpectError - random( true, 2.0, 5.0, {} ); // $ExpectError - random( false, 2.0, 5.0, {} ); // $ExpectError - random( null, 2.0, 5.0, {} ); // $ExpectError - random( [], 2.0, 5.0, {} ); // $ExpectError - random( {}, 2.0, 5.0, {} ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.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 ); // $ExpectError - random( 10, true, 5.0 ); // $ExpectError - random( 10, false, 5.0 ); // $ExpectError - random( 10, null, 5.0 ); // $ExpectError - random( 10, [], 5.0 ); // $ExpectError - random( 10, {}, 5.0 ); // $ExpectError - random( 10, ( x: number ): number => x, 5.0 ); // $ExpectError - - random( 10, '5', 5.0, {} ); // $ExpectError - random( 10, true, 5.0, {} ); // $ExpectError - random( 10, false, 5.0, {} ); // $ExpectError - random( 10, null, 5.0, {} ); // $ExpectError - random( 10, [], 5.0, {} ); // $ExpectError - random( 10, {}, 5.0, {} ); // $ExpectError - random( 10, ( x: number ): number => x, 5.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' ); // $ExpectError - random( 10, 2.0, true ); // $ExpectError - random( 10, 2.0, false ); // $ExpectError - random( 10, 2.0, null ); // $ExpectError - random( 10, 2.0, [] ); // $ExpectError - random( 10, 2.0, {} ); // $ExpectError - random( 10, 2.0, ( x: number ): number => x ); // $ExpectError - - random( 10, 2.0, '5', {} ); // $ExpectError - random( 10, 2.0, true, {} ); // $ExpectError - random( 10, 2.0, false, {} ); // $ExpectError - random( 10, 2.0, null, {} ); // $ExpectError - random( 10, 2.0, [], {} ); // $ExpectError - random( 10, 2.0, {}, {} ); // $ExpectError - random( 10, 2.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, '5' ); // $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, [] ); // $ExpectError - random( 10, 2.0, 5.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, { 'dtype': 123 } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': null } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - random( 10, 2.0, 5.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 -} - -// Attached to the main export is an `assign` method which returns an array... -{ - const x = zeros( 10, 'float64' ); - - random.assign( 2.0, 5.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, x ); // $ExpectError - random.assign( true, 5.0, x ); // $ExpectError - random.assign( false, 5.0, x ); // $ExpectError - random.assign( null, 5.0, x ); // $ExpectError - random.assign( [], 5.0, x ); // $ExpectError - random.assign( {}, 5.0, x ); // $ExpectError - random.assign( ( x: number ): number => x, 5.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', x ); // $ExpectError - random.assign( 2.0, true, x ); // $ExpectError - random.assign( 2.0, false, x ); // $ExpectError - random.assign( 2.0, null, x ); // $ExpectError - random.assign( 2.0, [], x ); // $ExpectError - random.assign( 2.0, {}, x ); // $ExpectError - random.assign( 2.0, ( x: number ): number => x, x ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid output array... -{ - random.assign( 2.0, 5.0, '5' ); // $ExpectError - random.assign( 2.0, 5.0, 5 ); // $ExpectError - random.assign( 2.0, 5.0, true ); // $ExpectError - random.assign( 2.0, 5.0, false ); // $ExpectError - random.assign( 2.0, 5.0, null ); // $ExpectError - random.assign( 2.0, 5.0, {} ); // $ExpectError - random.assign( 2.0, 5.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const 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 -} - -// Attached to main export is a `factory` method which returns a function... -{ - random.factory( 2.0, 5.0 ); // $ExpectType UnaryFunction - random.factory( 2.0, 5.0, { 'copy': false } ); // $ExpectType UnaryFunction - - random.factory(); // $ExpectType TernaryFunction - random.factory( { 'copy': false } ); // $ExpectType TernaryFunction -} - -// The `factory` method returns a function which returns an array... -{ - const fcn1 = random.factory( 2.0, 5.0 ); - fcn1( 10 ); // $ExpectType RandomArray - - const fcn2 = random.factory(); - fcn2( 10, 2.0, 5.0 ); // $ExpectType RandomArray -} - -// The compiler throws an error if the `factory` method is provided invalid arguments... -{ - random.factory( '5', 5.0 ); // $ExpectError - random.factory( true, 5.0 ); // $ExpectError - random.factory( false, 5.0 ); // $ExpectError - random.factory( [], 5.0 ); // $ExpectError - random.factory( {}, 5.0 ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0 ); // $ExpectError - - random.factory( '5', 5.0, {} ); // $ExpectError - random.factory( true, 5.0, {} ); // $ExpectError - random.factory( false, 5.0, {} ); // $ExpectError - random.factory( [], 5.0, {} ); // $ExpectError - random.factory( {}, 5.0, {} ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0, {} ); // $ExpectError - - random.factory( 2.0, '5' ); // $ExpectError - random.factory( 2.0, true ); // $ExpectError - random.factory( 2.0, false ); // $ExpectError - random.factory( 2.0, [] ); // $ExpectError - random.factory( 2.0, {} ); // $ExpectError - random.factory( 2.0, ( x: number ): number => x ); // $ExpectError - - random.factory( 2.0, '5', {} ); // $ExpectError - random.factory( 2.0, true, {} ); // $ExpectError - random.factory( 2.0, false, {} ); // $ExpectError - random.factory( 2.0, [], {} ); // $ExpectError - random.factory( 2.0, {}, {} ); // $ExpectError - random.factory( 2.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, 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, { 'prng': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'seed': true } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': [ 'a' ] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'state': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': {} } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': true } ); // $ExpectError - random.factory( 2.0, 5.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, { 'copy': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'dtype': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - random.factory( 2.0, 5.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, {}, {} ); // $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 ); - 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 ); // $ExpectError - fcn2( false, 2.0, 5.0 ); // $ExpectError - fcn2( '5', 2.0, 5.0 ); // $ExpectError - fcn2( [], 2.0, 5.0 ); // $ExpectError - fcn2( {}, 2.0, 5.0 ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - fcn2( true, 2.0, 5.0, {} ); // $ExpectError - fcn2( false, 2.0, 5.0, {} ); // $ExpectError - fcn2( '5', 2.0, 5.0, {} ); // $ExpectError - fcn2( [], 2.0, 5.0, {} ); // $ExpectError - fcn2( {}, 2.0, 5.0, {} ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0, {} ); // $ExpectError - - fcn2( 10, true, 5.0 ); // $ExpectError - fcn2( 10, false, 5.0 ); // $ExpectError - fcn2( 10, '5', 5.0 ); // $ExpectError - fcn2( 10, [], 5.0 ); // $ExpectError - fcn2( 10, {}, 5.0 ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0 ); // $ExpectError - - fcn2( 10, true, 5.0, {} ); // $ExpectError - fcn2( 10, false, 5.0, {} ); // $ExpectError - fcn2( 10, '5', 5.0, {} ); // $ExpectError - fcn2( 10, [], 5.0, {} ); // $ExpectError - fcn2( 10, {}, 5.0, {} ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0, {} ); // $ExpectError - - fcn2( 10, 2.0, true ); // $ExpectError - fcn2( 10, 2.0, false ); // $ExpectError - fcn2( 10, 2.0, '5' ); // $ExpectError - fcn2( 10, 2.0, [] ); // $ExpectError - fcn2( 10, 2.0, {} ); // $ExpectError - fcn2( 10, 2.0, ( x: number ): number => x ); // $ExpectError - - fcn2( 10, 2.0, true, {} ); // $ExpectError - fcn2( 10, 2.0, false, {} ); // $ExpectError - fcn2( 10, 2.0, '5', {} ); // $ExpectError - fcn2( 10, 2.0, [], {} ); // $ExpectError - fcn2( 10, 2.0, {}, {} ); // $ExpectError - fcn2( 10, 2.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, { 'dtype': 123 } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': null } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError - - const fcn2 = random.factory( 2.0, 5.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 ); - fcn1(); // $ExpectError - fcn1( 1, 1, 1 ); // $ExpectError - - const fcn2 = random.factory(); - fcn2(); // $ExpectError - fcn2( 1 ); // $ExpectError - fcn2( 1, 1, 1, 1 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index c485546..0000000 --- a/examples/index.js +++ /dev/null @@ -1,48 +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'; - -var logEach = require( '@stdlib/console-log-each' ); -var uniform = require( './../lib' ); - -// Create a function for generating random arrays originating from the same state: -var random = uniform.factory( 2.0, 5.0, { - 'state': uniform.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 = uniform.factory( 2.0, 5.0, { - 'state': uniform.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 9a727e8..2935269 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..02f69bc --- /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-binary-factory@v0.2.1-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtypes@v0.2.1-esm/index.mjs";import r 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-uniform@v0.2.1-esm/index.mjs";var d=e(n,s("real_floating_point_and_generic"),r.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..ab36cb6 --- /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) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 binaryFactory from '@stdlib/random-array-tools-binary-factory';\nimport dtypes from '@stdlib/array-dtypes';\nimport defaults from '@stdlib/array-defaults';\nimport base from '@stdlib/random-base-uniform';\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 continuous uniform distribution.\n*\n* @name factory\n* @type {Function}\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\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} 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 uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10 );\n* // returns \n*\n* @example\n* var uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar factory = binaryFactory( 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) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution.\n*\n* @name uniform\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\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 = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar uniform = factory();\n\n\n// EXPORTS //\n\nexport default uniform;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution.\n*\n* @module @stdlib/random-array-uniform\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.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","binaryFactory","base","dtypes","defaults","get","uniform","setReadOnly","main"],"mappings":";;kfA8BA,IAyCIA,EAAUC,EAAeC,EAzChBC,EAAQ,mCAyCsBC,EAASC,IAAK,+BCnBrDC,EAAUN,ICiBdO,EAAAC,EAAA,UAAAR"} \ No newline at end of file diff --git a/lib/factory.js b/lib/factory.js deleted file mode 100644 index 79da171..0000000 --- a/lib/factory.js +++ /dev/null @@ -1,77 +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 binaryFactory = require( '@stdlib/random-array-tools-binary-factory' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var defaults = require( '@stdlib/array-defaults' ); -var base = require( '@stdlib/random-base-uniform' ); - - -// VARIABLES // - -var DTYPES = dtypes( 'real_floating_point_and_generic' ); - - -// MAIN // - -/** -* Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution. -* -* @name factory -* @type {Function} -* @param {number} [a] - minimum support -* @param {number} [b] - maximum support -* @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} 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 uniform = factory( 2.0, 5.0 ); -* // returns -* -* var arr = uniform( 10 ); -* // returns -* -* @example -* var uniform = factory( 2.0, 5.0 ); -* // returns -* -* var arr = uniform( 10, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -var factory = binaryFactory( 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 3376c12..0000000 --- a/lib/index.js +++ /dev/null @@ -1,77 +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'; - -/** -* Create an array containing pseudorandom numbers drawn from a continuous uniform distribution. -* -* @module @stdlib/random-array-uniform -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var arr = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var arr = uniform( 10, 2.0, 5.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var rand = uniform.factory( 2.0, 5.0 ); -* // returns -* -* var arr = rand( 10 ); -* // returns -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var rand = uniform.factory( 2.0, 5.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 f93ef8f..0000000 --- a/lib/main.js +++ /dev/null @@ -1,58 +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 factory = require( './factory.js' ); - - -// MAIN // - -/** -* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution. -* -* @name uniform -* @type {Function} -* @param {NonNegativeInteger} len - array length -* @param {number} a - minimum support -* @param {number} b - maximum support -* @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 = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var arr = uniform( 10, 2.0, 5.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -var uniform = factory(); - - -// EXPORTS // - -module.exports = uniform; diff --git a/package.json b/package.json index 422e16f..78b1595 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 continuous uniform 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-binary-factory": "^0.2.1", - "@stdlib/random-base-uniform": "^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..8509c12 --- /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 14d34c7..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, 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, 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, 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, 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 765abb1..0000000 --- a/test/test.factory.js +++ /dev/null @@ -1,1261 +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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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, 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, { - '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, { - '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, { - '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, { - '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, { - '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, { - '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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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 ); - - 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 ); - - 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, { - '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 ); - - 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 ); - 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 ); - - 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 ); - - 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 ); - - 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 ); - - 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, { - '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 ); - - 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, { - '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 ); - - 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, { - '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 ); - - 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, { - '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 ); - - 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, { - '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, { - '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 ); - - // 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, { - '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 ); - - // 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, { - '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 ); - - 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, { - 'prng': randu.normalized - }); - - randu = minstd.factory({ - 'seed': seed - }); - random2 = factory( 2.0, 5.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 ); - arr2 = random2( 10, 2.0, 5.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 4e0f74d..0000000 --- a/test/test.js +++ /dev/null @@ -1,74 +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 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 faf9d84..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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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, 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, { - '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 ); - - 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, { - '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, { - '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, { - '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 ); - } - // Capture the current state: - state = random.state; - - // Move to a future state... - arr = random( 10, 2.0, 5.0 ); - for ( i = 0; i < 100; i++ ) { - random( 2, 2.0, 5.0 ); - } - // Set the state: - random.state = state; - - // Replay previously generated values: - t.deepEqual( random( 10, 2.0, 5.0 ), arr, 'returns expected value' ); - - t.end(); -}); From ba7fdd03cbcdf2fff2a7865de44fcbde920b93b7 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 12 Apr 2024 04:22:25 +0000 Subject: [PATCH 74/82] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 5d1204a..422e16f 100644 --- a/package.json +++ b/package.json @@ -42,7 +42,8 @@ "@stdlib/random-array-tools-binary-factory": "^0.2.1", "@stdlib/random-base-uniform": "^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 e6d0dc0734bae73febcb5d6eec9334d6031af8eb Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 12 Apr 2024 10:02:30 +0000 Subject: [PATCH 75/82] Remove files --- index.d.ts | 279 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5126 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 2935269..0000000 --- a/index.d.ts +++ /dev/null @@ -1,279 +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. -*/ - -// 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 continuous uniform distribution with pre-specified parameter values. -*/ -interface UnaryFunction extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform 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 continuous uniform distribution. - * - * @param out - output array - * @returns output array - */ - assign( out: RandomArray ): RandomArray; -} - -/** -* Interface for generating pseudorandom numbers drawn from a continuous uniform distribution without pre-specified parameter values. -*/ -interface TernaryFunction extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution. - * - * @param len - array length - * @param a - minimum support - * @param b - maximum support - * @param options - function options - * @returns output array - */ - ( len: number, a: number, b: number, options?: Options ): RandomArray; - - /** - * Fills an array with pseudorandom numbers drawn from a continuous uniform distribution. - * - * @param a - minimum support - * @param b - maximum support - * @param out - output array - * @returns output array - */ - assign( a: number, b: number, out: RandomArray ): RandomArray; -} - -/** -* Interface for generating pseudorandom numbers drawn from a continuous uniform distribution. -*/ -interface Random extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution. - * - * @param len - array length - * @param a - minimum support - * @param b - maximum support - * @param options - function options - * @returns output array - * - * @example - * var out = uniform( 10, 2.0, 5.0 ); - * // returns - */ - ( len: number, a: number, b: number, options?: Options ): RandomArray; - - /** - * Fills an array with pseudorandom numbers drawn from a continuous uniform distribution. - * - * @param a - minimum support - * @param b - maximum support - * @param out - output array - * @returns output array - * - * @example - * var zeros = require( '@stdlib/array-zeros' ); - * - * var x = zeros( 10, 'float64' ); - * // returns - * - * var out = uniform( 2.0, 5.0, out ); - * // returns - * - * var bool = ( out === x ); - * // returns true - */ - assign( a: number, b: number, out: RandomArray ): RandomArray; - - /** - * Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform 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 options - function options - * @throws must provide a valid state - * @returns function for creating arrays - * - * @example - * var random = uniform.factory( 2.0, 5.0 ); - * - * var out = random( 10 ); - * // returns - * - * @example - * var random = uniform.factory( 2.0, 5.0, { - * 'seed': 297 - * }); - * var out = random( 10 ); - * // returns - */ - factory( a: number, b: number, options?: FactoryOptions ): UnaryFunction; - - /** - * Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform 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 = uniform.factory(); - * - * var out = random( 10, 2.0, 5.0 ); - * // returns - * - * @example - * var random = uniform.factory({ - * 'seed': 297 - * }); - * var out = random( 10, 2.0, 5.0 ); - * // returns - */ - factory( options?: FactoryOptions ): TernaryFunction; -} - -/** -* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution. -* -* @param len - array length -* @param a - minimum support -* @param b - maximum support -* @param options - function options -* @returns output array -* -* @example -* var out = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var random = uniform.factory( 2.0, 5.0 ); -* -* var out = random( 10 ); -* // returns -*/ -declare var uniform: Random; - - -// EXPORTS // - -export = uniform; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 02f69bc..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-binary-factory@v0.2.1-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtypes@v0.2.1-esm/index.mjs";import r 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-uniform@v0.2.1-esm/index.mjs";var d=e(n,s("real_floating_point_and_generic"),r.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 ab36cb6..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) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 binaryFactory from '@stdlib/random-array-tools-binary-factory';\nimport dtypes from '@stdlib/array-dtypes';\nimport defaults from '@stdlib/array-defaults';\nimport base from '@stdlib/random-base-uniform';\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 continuous uniform distribution.\n*\n* @name factory\n* @type {Function}\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\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} 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 uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10 );\n* // returns \n*\n* @example\n* var uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar factory = binaryFactory( 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) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution.\n*\n* @name uniform\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\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 = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar uniform = factory();\n\n\n// EXPORTS //\n\nexport default uniform;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution.\n*\n* @module @stdlib/random-array-uniform\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.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","binaryFactory","base","dtypes","defaults","get","uniform","setReadOnly","main"],"mappings":";;kfA8BA,IAyCIA,EAAUC,EAAeC,EAzChBC,EAAQ,mCAyCsBC,EAASC,IAAK,+BCnBrDC,EAAUN,ICiBdO,EAAAC,EAAA,UAAAR"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 8509c12..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 45cf3cfc01ca4292860ddc2836c1c932b2c356a1 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 12 Apr 2024 10:02:50 +0000 Subject: [PATCH 76/82] 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 | 69 +- 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 | 198 - docs/types/test.ts | 409 -- examples/index.js | 48 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/factory.js | 77 - lib/index.js | 77 - lib/main.js | 58 - package.json | 71 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 118 - test/test.factory.js | 1261 ------ test/test.js | 74 - test/test.main.js | 244 -- 54 files changed, 4884 insertions(+), 6820 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 c4ab52b..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/uniform) 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 5097056..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/uniform) 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 31ea6a7..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: '33 9 * * 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,19 +468,19 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/random-array-uniform/main/LICENSE -[@stdlib/random/base/uniform]: https://github.com/stdlib-js/random-base-uniform +[@stdlib/random/base/uniform]: https://github.com/stdlib-js/random-base-uniform/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 -[@stdlib/random/array/discrete-uniform]: https://github.com/stdlib-js/random-array-discrete-uniform +[@stdlib/random/array/discrete-uniform]: https://github.com/stdlib-js/random-array-discrete-uniform/tree/esm -[@stdlib/random/strided/uniform]: https://github.com/stdlib-js/random-strided-uniform +[@stdlib/random/strided/uniform]: https://github.com/stdlib-js/random-strided-uniform/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 4923816..0000000 --- a/benchmark/benchmark.float32.assign.js +++ /dev/null @@ -1,97 +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 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, 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 dea0644..0000000 --- a/benchmark/benchmark.float32.factory.js +++ /dev/null @@ -1,96 +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 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, { - '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 4249752..0000000 --- a/benchmark/benchmark.float32.js +++ /dev/null @@ -1,98 +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 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, 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 8cf1538..0000000 --- a/benchmark/benchmark.float64.assign.js +++ /dev/null @@ -1,97 +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 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, 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 f352bca..0000000 --- a/benchmark/benchmark.float64.factory.js +++ /dev/null @@ -1,96 +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 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, { - '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 e176e0a..0000000 --- a/benchmark/benchmark.float64.js +++ /dev/null @@ -1,98 +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 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, 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 6038ee7..0000000 --- a/benchmark/benchmark.generic.assign.js +++ /dev/null @@ -1,97 +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 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, 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 6a6bddc..0000000 --- a/benchmark/benchmark.generic.factory.js +++ /dev/null @@ -1,96 +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 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, { - '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 b6bdcfd..0000000 --- a/benchmark/benchmark.generic.js +++ /dev/null @@ -1,98 +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 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, 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 5a79fd6..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/uniform" -%% click B href "https://github.com/stdlib-js/random-array-uniform/tree/main" -%% click C href "https://github.com/stdlib-js/random-array-uniform/tree/production" -%% click D href "https://github.com/stdlib-js/random-array-uniform/tree/esm" -%% click E href "https://github.com/stdlib-js/random-array-uniform/tree/deno" -%% click F href "https://github.com/stdlib-js/random-array-uniform/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/uniform -[production-url]: https://github.com/stdlib-js/random-array-uniform/tree/production -[deno-url]: https://github.com/stdlib-js/random-array-uniform/tree/deno -[deno-readme]: https://github.com/stdlib-js/random-array-uniform/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/random-array-uniform/tree/umd -[umd-readme]: https://github.com/stdlib-js/random-array-uniform/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/random-array-uniform/tree/esm -[esm-readme]: https://github.com/stdlib-js/random-array-uniform/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 f2a679f..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import uniform from '../docs/types/index'; -export = uniform; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index f49a668..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var a=function(u,r){return function(){return r||u((r={exports:{}}).exports,r),r.exports}};var e=a(function(x,t){ -var v=require('@stdlib/random-array-tools-binary-factory/dist'),n=require('@stdlib/array-dtypes/dist'),c=require('@stdlib/array-defaults/dist'),y=require('@stdlib/random-base-uniform/dist'),f=n("real_floating_point_and_generic"),q=v(y,f,c.get("dtypes.real_floating_point"));t.exports=q -});var s=a(function(b,i){ -var p=e(),l=p();i.exports=l -});var _=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),o=s(),d=e();_(o,"factory",d);module.exports=o; -/** @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 815b1ac..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) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 binaryFactory = require( '@stdlib/random-array-tools-binary-factory' );\nvar dtypes = require( '@stdlib/array-dtypes' );\nvar defaults = require( '@stdlib/array-defaults' );\nvar base = require( '@stdlib/random-base-uniform' );\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 continuous uniform distribution.\n*\n* @name factory\n* @type {Function}\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\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} 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 uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10 );\n* // returns \n*\n* @example\n* var uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar factory = binaryFactory( 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) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution.\n*\n* @name uniform\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\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 = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar uniform = factory();\n\n\n// EXPORTS //\n\nmodule.exports = uniform;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution.\n*\n* @module @stdlib/random-array-uniform\n*\n* @example\n* var uniform = require( '@stdlib/random-array-uniform' );\n*\n* var arr = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var uniform = require( '@stdlib/random-array-uniform' );\n*\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* var uniform = require( '@stdlib/random-array-uniform' );\n*\n* var rand = uniform.factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* var uniform = require( '@stdlib/random-array-uniform' );\n*\n* var rand = uniform.factory( 2.0, 5.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,EAAgB,QAAS,2CAA4C,EACrEC,EAAS,QAAS,sBAAuB,EACzCC,EAAW,QAAS,wBAAyB,EAC7CC,EAAO,QAAS,6BAA8B,EAK9CC,EAASH,EAAQ,iCAAkC,EAyCnDI,EAAUL,EAAeG,EAAMC,EAAQF,EAAS,IAAK,4BAA6B,CAAE,EAKxFH,EAAO,QAAUM,IC5EjB,IAAAC,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,IA8BVC,EAAUD,EAAQ,EAKtBD,EAAO,QAAUE,ICKjB,IAAIC,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAU,IAKdF,EAAaC,EAAM,UAAWC,CAAQ,EAKtC,OAAO,QAAUD", - "names": ["require_factory", "__commonJSMin", "exports", "module", "binaryFactory", "dtypes", "defaults", "base", "DTYPES", "factory", "require_main", "__commonJSMin", "exports", "module", "factory", "uniform", "setReadOnly", "main", "factory"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index af6976c..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,198 +0,0 @@ - -{{alias}}( len, a, b[, options] ) - Returns an array containing pseudorandom numbers drawn from a continuous - uniform distribution. - - Parameters - ---------- - len: integer - Output array length. - - a: number - Minimum support. - - b: number - Maximum support. - - 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 ) - - - -{{alias}}.assign( a, b, out ) - Fills an array with pseudorandom numbers drawn from a continuous uniform - distribution. - - Parameters - ---------- - a: number - Minimum support. - - b: number - Maximum support. - - 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, x ) - - > var bool = ( out === x ) - true - - -{{alias}}.factory( [a, b, ][options] ) - Returns a function for creating arrays containing pseudorandom numbers drawn - from a continuous uniform 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. - - 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 ) - - - // Provide distribution parameters: - > fcn = {{alias}}.factory( 2.0, 5.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 ) - - - // Get a copy of the current state: - > var state = {{alias}}.state - - - > out = {{alias}}( 3, 2.0, 5.0 ) - - > out = {{alias}}( 3, 2.0, 5.0 ) - - - // Set the state: - > {{alias}}.state = state; - - // Regenerate a previous array: - > out = {{alias}}( 3, 2.0, 5.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 9e8939e..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,409 +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. -*/ - -import zeros = require( '@stdlib/array-zeros' ); -import random = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - random( 10, 2.0, 5.0 ); // $ExpectType RandomArray - random( 10, 2.0, 5.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 ); // $ExpectError - random( true, 2.0, 5.0 ); // $ExpectError - random( false, 2.0, 5.0 ); // $ExpectError - random( null, 2.0, 5.0 ); // $ExpectError - random( [], 2.0, 5.0 ); // $ExpectError - random( {}, 2.0, 5.0 ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - random( '5', 2.0, 5.0, {} ); // $ExpectError - random( true, 2.0, 5.0, {} ); // $ExpectError - random( false, 2.0, 5.0, {} ); // $ExpectError - random( null, 2.0, 5.0, {} ); // $ExpectError - random( [], 2.0, 5.0, {} ); // $ExpectError - random( {}, 2.0, 5.0, {} ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.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 ); // $ExpectError - random( 10, true, 5.0 ); // $ExpectError - random( 10, false, 5.0 ); // $ExpectError - random( 10, null, 5.0 ); // $ExpectError - random( 10, [], 5.0 ); // $ExpectError - random( 10, {}, 5.0 ); // $ExpectError - random( 10, ( x: number ): number => x, 5.0 ); // $ExpectError - - random( 10, '5', 5.0, {} ); // $ExpectError - random( 10, true, 5.0, {} ); // $ExpectError - random( 10, false, 5.0, {} ); // $ExpectError - random( 10, null, 5.0, {} ); // $ExpectError - random( 10, [], 5.0, {} ); // $ExpectError - random( 10, {}, 5.0, {} ); // $ExpectError - random( 10, ( x: number ): number => x, 5.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' ); // $ExpectError - random( 10, 2.0, true ); // $ExpectError - random( 10, 2.0, false ); // $ExpectError - random( 10, 2.0, null ); // $ExpectError - random( 10, 2.0, [] ); // $ExpectError - random( 10, 2.0, {} ); // $ExpectError - random( 10, 2.0, ( x: number ): number => x ); // $ExpectError - - random( 10, 2.0, '5', {} ); // $ExpectError - random( 10, 2.0, true, {} ); // $ExpectError - random( 10, 2.0, false, {} ); // $ExpectError - random( 10, 2.0, null, {} ); // $ExpectError - random( 10, 2.0, [], {} ); // $ExpectError - random( 10, 2.0, {}, {} ); // $ExpectError - random( 10, 2.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, '5' ); // $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, [] ); // $ExpectError - random( 10, 2.0, 5.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, { 'dtype': 123 } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': null } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - random( 10, 2.0, 5.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 -} - -// Attached to the main export is an `assign` method which returns an array... -{ - const x = zeros( 10, 'float64' ); - - random.assign( 2.0, 5.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, x ); // $ExpectError - random.assign( true, 5.0, x ); // $ExpectError - random.assign( false, 5.0, x ); // $ExpectError - random.assign( null, 5.0, x ); // $ExpectError - random.assign( [], 5.0, x ); // $ExpectError - random.assign( {}, 5.0, x ); // $ExpectError - random.assign( ( x: number ): number => x, 5.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', x ); // $ExpectError - random.assign( 2.0, true, x ); // $ExpectError - random.assign( 2.0, false, x ); // $ExpectError - random.assign( 2.0, null, x ); // $ExpectError - random.assign( 2.0, [], x ); // $ExpectError - random.assign( 2.0, {}, x ); // $ExpectError - random.assign( 2.0, ( x: number ): number => x, x ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid output array... -{ - random.assign( 2.0, 5.0, '5' ); // $ExpectError - random.assign( 2.0, 5.0, 5 ); // $ExpectError - random.assign( 2.0, 5.0, true ); // $ExpectError - random.assign( 2.0, 5.0, false ); // $ExpectError - random.assign( 2.0, 5.0, null ); // $ExpectError - random.assign( 2.0, 5.0, {} ); // $ExpectError - random.assign( 2.0, 5.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const 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 -} - -// Attached to main export is a `factory` method which returns a function... -{ - random.factory( 2.0, 5.0 ); // $ExpectType UnaryFunction - random.factory( 2.0, 5.0, { 'copy': false } ); // $ExpectType UnaryFunction - - random.factory(); // $ExpectType TernaryFunction - random.factory( { 'copy': false } ); // $ExpectType TernaryFunction -} - -// The `factory` method returns a function which returns an array... -{ - const fcn1 = random.factory( 2.0, 5.0 ); - fcn1( 10 ); // $ExpectType RandomArray - - const fcn2 = random.factory(); - fcn2( 10, 2.0, 5.0 ); // $ExpectType RandomArray -} - -// The compiler throws an error if the `factory` method is provided invalid arguments... -{ - random.factory( '5', 5.0 ); // $ExpectError - random.factory( true, 5.0 ); // $ExpectError - random.factory( false, 5.0 ); // $ExpectError - random.factory( [], 5.0 ); // $ExpectError - random.factory( {}, 5.0 ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0 ); // $ExpectError - - random.factory( '5', 5.0, {} ); // $ExpectError - random.factory( true, 5.0, {} ); // $ExpectError - random.factory( false, 5.0, {} ); // $ExpectError - random.factory( [], 5.0, {} ); // $ExpectError - random.factory( {}, 5.0, {} ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0, {} ); // $ExpectError - - random.factory( 2.0, '5' ); // $ExpectError - random.factory( 2.0, true ); // $ExpectError - random.factory( 2.0, false ); // $ExpectError - random.factory( 2.0, [] ); // $ExpectError - random.factory( 2.0, {} ); // $ExpectError - random.factory( 2.0, ( x: number ): number => x ); // $ExpectError - - random.factory( 2.0, '5', {} ); // $ExpectError - random.factory( 2.0, true, {} ); // $ExpectError - random.factory( 2.0, false, {} ); // $ExpectError - random.factory( 2.0, [], {} ); // $ExpectError - random.factory( 2.0, {}, {} ); // $ExpectError - random.factory( 2.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, 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, { 'prng': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'seed': true } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': [ 'a' ] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'state': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': {} } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': true } ); // $ExpectError - random.factory( 2.0, 5.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, { 'copy': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'dtype': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - random.factory( 2.0, 5.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, {}, {} ); // $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 ); - 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 ); // $ExpectError - fcn2( false, 2.0, 5.0 ); // $ExpectError - fcn2( '5', 2.0, 5.0 ); // $ExpectError - fcn2( [], 2.0, 5.0 ); // $ExpectError - fcn2( {}, 2.0, 5.0 ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - fcn2( true, 2.0, 5.0, {} ); // $ExpectError - fcn2( false, 2.0, 5.0, {} ); // $ExpectError - fcn2( '5', 2.0, 5.0, {} ); // $ExpectError - fcn2( [], 2.0, 5.0, {} ); // $ExpectError - fcn2( {}, 2.0, 5.0, {} ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0, {} ); // $ExpectError - - fcn2( 10, true, 5.0 ); // $ExpectError - fcn2( 10, false, 5.0 ); // $ExpectError - fcn2( 10, '5', 5.0 ); // $ExpectError - fcn2( 10, [], 5.0 ); // $ExpectError - fcn2( 10, {}, 5.0 ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0 ); // $ExpectError - - fcn2( 10, true, 5.0, {} ); // $ExpectError - fcn2( 10, false, 5.0, {} ); // $ExpectError - fcn2( 10, '5', 5.0, {} ); // $ExpectError - fcn2( 10, [], 5.0, {} ); // $ExpectError - fcn2( 10, {}, 5.0, {} ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0, {} ); // $ExpectError - - fcn2( 10, 2.0, true ); // $ExpectError - fcn2( 10, 2.0, false ); // $ExpectError - fcn2( 10, 2.0, '5' ); // $ExpectError - fcn2( 10, 2.0, [] ); // $ExpectError - fcn2( 10, 2.0, {} ); // $ExpectError - fcn2( 10, 2.0, ( x: number ): number => x ); // $ExpectError - - fcn2( 10, 2.0, true, {} ); // $ExpectError - fcn2( 10, 2.0, false, {} ); // $ExpectError - fcn2( 10, 2.0, '5', {} ); // $ExpectError - fcn2( 10, 2.0, [], {} ); // $ExpectError - fcn2( 10, 2.0, {}, {} ); // $ExpectError - fcn2( 10, 2.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, { 'dtype': 123 } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': null } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError - - const fcn2 = random.factory( 2.0, 5.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 ); - fcn1(); // $ExpectError - fcn1( 1, 1, 1 ); // $ExpectError - - const fcn2 = random.factory(); - fcn2(); // $ExpectError - fcn2( 1 ); // $ExpectError - fcn2( 1, 1, 1, 1 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index c485546..0000000 --- a/examples/index.js +++ /dev/null @@ -1,48 +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'; - -var logEach = require( '@stdlib/console-log-each' ); -var uniform = require( './../lib' ); - -// Create a function for generating random arrays originating from the same state: -var random = uniform.factory( 2.0, 5.0, { - 'state': uniform.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 = uniform.factory( 2.0, 5.0, { - 'state': uniform.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 9a727e8..2935269 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..02f69bc --- /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-binary-factory@v0.2.1-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtypes@v0.2.1-esm/index.mjs";import r 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-uniform@v0.2.1-esm/index.mjs";var d=e(n,s("real_floating_point_and_generic"),r.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..ab36cb6 --- /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) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 binaryFactory from '@stdlib/random-array-tools-binary-factory';\nimport dtypes from '@stdlib/array-dtypes';\nimport defaults from '@stdlib/array-defaults';\nimport base from '@stdlib/random-base-uniform';\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 continuous uniform distribution.\n*\n* @name factory\n* @type {Function}\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\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} 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 uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10 );\n* // returns \n*\n* @example\n* var uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar factory = binaryFactory( 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) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution.\n*\n* @name uniform\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\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 = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar uniform = factory();\n\n\n// EXPORTS //\n\nexport default uniform;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution.\n*\n* @module @stdlib/random-array-uniform\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.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","binaryFactory","base","dtypes","defaults","get","uniform","setReadOnly","main"],"mappings":";;kfA8BA,IAyCIA,EAAUC,EAAeC,EAzChBC,EAAQ,mCAyCsBC,EAASC,IAAK,+BCnBrDC,EAAUN,ICiBdO,EAAAC,EAAA,UAAAR"} \ No newline at end of file diff --git a/lib/factory.js b/lib/factory.js deleted file mode 100644 index 79da171..0000000 --- a/lib/factory.js +++ /dev/null @@ -1,77 +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 binaryFactory = require( '@stdlib/random-array-tools-binary-factory' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var defaults = require( '@stdlib/array-defaults' ); -var base = require( '@stdlib/random-base-uniform' ); - - -// VARIABLES // - -var DTYPES = dtypes( 'real_floating_point_and_generic' ); - - -// MAIN // - -/** -* Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution. -* -* @name factory -* @type {Function} -* @param {number} [a] - minimum support -* @param {number} [b] - maximum support -* @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} 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 uniform = factory( 2.0, 5.0 ); -* // returns -* -* var arr = uniform( 10 ); -* // returns -* -* @example -* var uniform = factory( 2.0, 5.0 ); -* // returns -* -* var arr = uniform( 10, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -var factory = binaryFactory( 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 3376c12..0000000 --- a/lib/index.js +++ /dev/null @@ -1,77 +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'; - -/** -* Create an array containing pseudorandom numbers drawn from a continuous uniform distribution. -* -* @module @stdlib/random-array-uniform -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var arr = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var arr = uniform( 10, 2.0, 5.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var rand = uniform.factory( 2.0, 5.0 ); -* // returns -* -* var arr = rand( 10 ); -* // returns -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var rand = uniform.factory( 2.0, 5.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 f93ef8f..0000000 --- a/lib/main.js +++ /dev/null @@ -1,58 +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 factory = require( './factory.js' ); - - -// MAIN // - -/** -* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution. -* -* @name uniform -* @type {Function} -* @param {NonNegativeInteger} len - array length -* @param {number} a - minimum support -* @param {number} b - maximum support -* @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 = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var arr = uniform( 10, 2.0, 5.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -var uniform = factory(); - - -// EXPORTS // - -module.exports = uniform; diff --git a/package.json b/package.json index 422e16f..78b1595 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 continuous uniform 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-binary-factory": "^0.2.1", - "@stdlib/random-base-uniform": "^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..8509c12 --- /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 14d34c7..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, 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, 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, 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, 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 765abb1..0000000 --- a/test/test.factory.js +++ /dev/null @@ -1,1261 +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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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, 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, { - '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, { - '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, { - '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, { - '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, { - '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, { - '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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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 ); - - 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 ); - - 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, { - '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 ); - - 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 ); - 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 ); - - 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 ); - - 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 ); - - 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 ); - - 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, { - '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 ); - - 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, { - '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 ); - - 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, { - '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 ); - - 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, { - '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 ); - - 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, { - '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, { - '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 ); - - // 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, { - '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 ); - - // 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, { - '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 ); - - 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, { - 'prng': randu.normalized - }); - - randu = minstd.factory({ - 'seed': seed - }); - random2 = factory( 2.0, 5.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 ); - arr2 = random2( 10, 2.0, 5.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 4e0f74d..0000000 --- a/test/test.js +++ /dev/null @@ -1,74 +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 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 faf9d84..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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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, 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, { - '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 ); - - 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, { - '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, { - '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, { - '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 ); - } - // Capture the current state: - state = random.state; - - // Move to a future state... - arr = random( 10, 2.0, 5.0 ); - for ( i = 0; i < 100; i++ ) { - random( 2, 2.0, 5.0 ); - } - // Set the state: - random.state = state; - - // Replay previously generated values: - t.deepEqual( random( 10, 2.0, 5.0 ), arr, 'returns expected value' ); - - t.end(); -}); From 5b1a12fe7f1cccfb5b874f8969d6d181b39e2a07 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 10 Mar 2025 01:57:03 +0000 Subject: [PATCH 77/82] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index bd9e800..5348d95 100644 --- a/package.json +++ b/package.json @@ -42,7 +42,8 @@ "@stdlib/random-array-tools-binary-factory": "^0.2.2", "@stdlib/random-base-uniform": "^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 816f6f267c345fe64157fe069f913743ba397677 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 10 Mar 2025 02:29:09 +0000 Subject: [PATCH 78/82] Remove files --- index.d.ts | 279 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5126 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 2935269..0000000 --- a/index.d.ts +++ /dev/null @@ -1,279 +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. -*/ - -// 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 continuous uniform distribution with pre-specified parameter values. -*/ -interface UnaryFunction extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform 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 continuous uniform distribution. - * - * @param out - output array - * @returns output array - */ - assign( out: RandomArray ): RandomArray; -} - -/** -* Interface for generating pseudorandom numbers drawn from a continuous uniform distribution without pre-specified parameter values. -*/ -interface TernaryFunction extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution. - * - * @param len - array length - * @param a - minimum support - * @param b - maximum support - * @param options - function options - * @returns output array - */ - ( len: number, a: number, b: number, options?: Options ): RandomArray; - - /** - * Fills an array with pseudorandom numbers drawn from a continuous uniform distribution. - * - * @param a - minimum support - * @param b - maximum support - * @param out - output array - * @returns output array - */ - assign( a: number, b: number, out: RandomArray ): RandomArray; -} - -/** -* Interface for generating pseudorandom numbers drawn from a continuous uniform distribution. -*/ -interface Random extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution. - * - * @param len - array length - * @param a - minimum support - * @param b - maximum support - * @param options - function options - * @returns output array - * - * @example - * var out = uniform( 10, 2.0, 5.0 ); - * // returns - */ - ( len: number, a: number, b: number, options?: Options ): RandomArray; - - /** - * Fills an array with pseudorandom numbers drawn from a continuous uniform distribution. - * - * @param a - minimum support - * @param b - maximum support - * @param out - output array - * @returns output array - * - * @example - * var zeros = require( '@stdlib/array-zeros' ); - * - * var x = zeros( 10, 'float64' ); - * // returns - * - * var out = uniform( 2.0, 5.0, out ); - * // returns - * - * var bool = ( out === x ); - * // returns true - */ - assign( a: number, b: number, out: RandomArray ): RandomArray; - - /** - * Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform 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 options - function options - * @throws must provide a valid state - * @returns function for creating arrays - * - * @example - * var random = uniform.factory( 2.0, 5.0 ); - * - * var out = random( 10 ); - * // returns - * - * @example - * var random = uniform.factory( 2.0, 5.0, { - * 'seed': 297 - * }); - * var out = random( 10 ); - * // returns - */ - factory( a: number, b: number, options?: FactoryOptions ): UnaryFunction; - - /** - * Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform 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 = uniform.factory(); - * - * var out = random( 10, 2.0, 5.0 ); - * // returns - * - * @example - * var random = uniform.factory({ - * 'seed': 297 - * }); - * var out = random( 10, 2.0, 5.0 ); - * // returns - */ - factory( options?: FactoryOptions ): TernaryFunction; -} - -/** -* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution. -* -* @param len - array length -* @param a - minimum support -* @param b - maximum support -* @param options - function options -* @returns output array -* -* @example -* var out = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var random = uniform.factory( 2.0, 5.0 ); -* -* var out = random( 10 ); -* // returns -*/ -declare var uniform: Random; - - -// EXPORTS // - -export = uniform; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 02f69bc..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-binary-factory@v0.2.1-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtypes@v0.2.1-esm/index.mjs";import r 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-uniform@v0.2.1-esm/index.mjs";var d=e(n,s("real_floating_point_and_generic"),r.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 ab36cb6..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) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 binaryFactory from '@stdlib/random-array-tools-binary-factory';\nimport dtypes from '@stdlib/array-dtypes';\nimport defaults from '@stdlib/array-defaults';\nimport base from '@stdlib/random-base-uniform';\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 continuous uniform distribution.\n*\n* @name factory\n* @type {Function}\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\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} 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 uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10 );\n* // returns \n*\n* @example\n* var uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar factory = binaryFactory( 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) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution.\n*\n* @name uniform\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\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 = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar uniform = factory();\n\n\n// EXPORTS //\n\nexport default uniform;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution.\n*\n* @module @stdlib/random-array-uniform\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.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","binaryFactory","base","dtypes","defaults","get","uniform","setReadOnly","main"],"mappings":";;kfA8BA,IAyCIA,EAAUC,EAAeC,EAzChBC,EAAQ,mCAyCsBC,EAASC,IAAK,+BCnBrDC,EAAUN,ICiBdO,EAAAC,EAAA,UAAAR"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 8509c12..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 83ae2e3919afd94e1ccdc4c01e8da7614a24b08f Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 10 Mar 2025 02:29:25 +0000 Subject: [PATCH 79/82] 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 | 170 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 69 +- 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 | 198 - docs/types/test.ts | 409 -- examples/index.js | 48 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/factory.js | 77 - lib/index.js | 77 - lib/main.js | 58 - package.json | 71 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 118 - test/test.factory.js | 1261 ----- test/test.js | 74 - test/test.main.js | 244 - 56 files changed, 4884 insertions(+), 7107 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 7398723..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2025-03-10T01:39:48.966Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 76a6357..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/uniform) 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 5097056..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/uniform) 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 31ea6a7..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: '33 9 * * 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,19 +468,19 @@ Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/random-array-uniform/main/LICENSE -[@stdlib/random/base/uniform]: https://github.com/stdlib-js/random-base-uniform +[@stdlib/random/base/uniform]: https://github.com/stdlib-js/random-base-uniform/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 -[@stdlib/random/array/discrete-uniform]: https://github.com/stdlib-js/random-array-discrete-uniform +[@stdlib/random/array/discrete-uniform]: https://github.com/stdlib-js/random-array-discrete-uniform/tree/esm -[@stdlib/random/strided/uniform]: https://github.com/stdlib-js/random-strided-uniform +[@stdlib/random/strided/uniform]: https://github.com/stdlib-js/random-strided-uniform/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 4923816..0000000 --- a/benchmark/benchmark.float32.assign.js +++ /dev/null @@ -1,97 +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 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, 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 dea0644..0000000 --- a/benchmark/benchmark.float32.factory.js +++ /dev/null @@ -1,96 +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 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, { - '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 4249752..0000000 --- a/benchmark/benchmark.float32.js +++ /dev/null @@ -1,98 +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 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, 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 8cf1538..0000000 --- a/benchmark/benchmark.float64.assign.js +++ /dev/null @@ -1,97 +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 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, 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 f352bca..0000000 --- a/benchmark/benchmark.float64.factory.js +++ /dev/null @@ -1,96 +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 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, { - '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 e176e0a..0000000 --- a/benchmark/benchmark.float64.js +++ /dev/null @@ -1,98 +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 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, 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 6038ee7..0000000 --- a/benchmark/benchmark.generic.assign.js +++ /dev/null @@ -1,97 +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 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, 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 6a6bddc..0000000 --- a/benchmark/benchmark.generic.factory.js +++ /dev/null @@ -1,96 +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 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, { - '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 b6bdcfd..0000000 --- a/benchmark/benchmark.generic.js +++ /dev/null @@ -1,98 +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 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, 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 5a79fd6..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/uniform" -%% click B href "https://github.com/stdlib-js/random-array-uniform/tree/main" -%% click C href "https://github.com/stdlib-js/random-array-uniform/tree/production" -%% click D href "https://github.com/stdlib-js/random-array-uniform/tree/esm" -%% click E href "https://github.com/stdlib-js/random-array-uniform/tree/deno" -%% click F href "https://github.com/stdlib-js/random-array-uniform/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/uniform -[production-url]: https://github.com/stdlib-js/random-array-uniform/tree/production -[deno-url]: https://github.com/stdlib-js/random-array-uniform/tree/deno -[deno-readme]: https://github.com/stdlib-js/random-array-uniform/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/random-array-uniform/tree/umd -[umd-readme]: https://github.com/stdlib-js/random-array-uniform/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/random-array-uniform/tree/esm -[esm-readme]: https://github.com/stdlib-js/random-array-uniform/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 f2a679f..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import uniform from '../docs/types/index'; -export = uniform; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index f49a668..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var a=function(u,r){return function(){return r||u((r={exports:{}}).exports,r),r.exports}};var e=a(function(x,t){ -var v=require('@stdlib/random-array-tools-binary-factory/dist'),n=require('@stdlib/array-dtypes/dist'),c=require('@stdlib/array-defaults/dist'),y=require('@stdlib/random-base-uniform/dist'),f=n("real_floating_point_and_generic"),q=v(y,f,c.get("dtypes.real_floating_point"));t.exports=q -});var s=a(function(b,i){ -var p=e(),l=p();i.exports=l -});var _=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),o=s(),d=e();_(o,"factory",d);module.exports=o; -/** @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 815b1ac..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) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 binaryFactory = require( '@stdlib/random-array-tools-binary-factory' );\nvar dtypes = require( '@stdlib/array-dtypes' );\nvar defaults = require( '@stdlib/array-defaults' );\nvar base = require( '@stdlib/random-base-uniform' );\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 continuous uniform distribution.\n*\n* @name factory\n* @type {Function}\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\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} 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 uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10 );\n* // returns \n*\n* @example\n* var uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar factory = binaryFactory( 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) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution.\n*\n* @name uniform\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\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 = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar uniform = factory();\n\n\n// EXPORTS //\n\nmodule.exports = uniform;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution.\n*\n* @module @stdlib/random-array-uniform\n*\n* @example\n* var uniform = require( '@stdlib/random-array-uniform' );\n*\n* var arr = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var uniform = require( '@stdlib/random-array-uniform' );\n*\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* var uniform = require( '@stdlib/random-array-uniform' );\n*\n* var rand = uniform.factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* var uniform = require( '@stdlib/random-array-uniform' );\n*\n* var rand = uniform.factory( 2.0, 5.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,EAAgB,QAAS,2CAA4C,EACrEC,EAAS,QAAS,sBAAuB,EACzCC,EAAW,QAAS,wBAAyB,EAC7CC,EAAO,QAAS,6BAA8B,EAK9CC,EAASH,EAAQ,iCAAkC,EAyCnDI,EAAUL,EAAeG,EAAMC,EAAQF,EAAS,IAAK,4BAA6B,CAAE,EAKxFH,EAAO,QAAUM,IC5EjB,IAAAC,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,IA8BVC,EAAUD,EAAQ,EAKtBD,EAAO,QAAUE,ICKjB,IAAIC,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAU,IAKdF,EAAaC,EAAM,UAAWC,CAAQ,EAKtC,OAAO,QAAUD", - "names": ["require_factory", "__commonJSMin", "exports", "module", "binaryFactory", "dtypes", "defaults", "base", "DTYPES", "factory", "require_main", "__commonJSMin", "exports", "module", "factory", "uniform", "setReadOnly", "main", "factory"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index af6976c..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,198 +0,0 @@ - -{{alias}}( len, a, b[, options] ) - Returns an array containing pseudorandom numbers drawn from a continuous - uniform distribution. - - Parameters - ---------- - len: integer - Output array length. - - a: number - Minimum support. - - b: number - Maximum support. - - 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 ) - - - -{{alias}}.assign( a, b, out ) - Fills an array with pseudorandom numbers drawn from a continuous uniform - distribution. - - Parameters - ---------- - a: number - Minimum support. - - b: number - Maximum support. - - 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, x ) - - > var bool = ( out === x ) - true - - -{{alias}}.factory( [a, b, ][options] ) - Returns a function for creating arrays containing pseudorandom numbers drawn - from a continuous uniform 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. - - 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 ) - - - // Provide distribution parameters: - > fcn = {{alias}}.factory( 2.0, 5.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 ) - - - // Get a copy of the current state: - > var state = {{alias}}.state - - - > out = {{alias}}( 3, 2.0, 5.0 ) - - > out = {{alias}}( 3, 2.0, 5.0 ) - - - // Set the state: - > {{alias}}.state = state; - - // Regenerate a previous array: - > out = {{alias}}( 3, 2.0, 5.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 9e8939e..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,409 +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. -*/ - -import zeros = require( '@stdlib/array-zeros' ); -import random = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - random( 10, 2.0, 5.0 ); // $ExpectType RandomArray - random( 10, 2.0, 5.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 ); // $ExpectError - random( true, 2.0, 5.0 ); // $ExpectError - random( false, 2.0, 5.0 ); // $ExpectError - random( null, 2.0, 5.0 ); // $ExpectError - random( [], 2.0, 5.0 ); // $ExpectError - random( {}, 2.0, 5.0 ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - random( '5', 2.0, 5.0, {} ); // $ExpectError - random( true, 2.0, 5.0, {} ); // $ExpectError - random( false, 2.0, 5.0, {} ); // $ExpectError - random( null, 2.0, 5.0, {} ); // $ExpectError - random( [], 2.0, 5.0, {} ); // $ExpectError - random( {}, 2.0, 5.0, {} ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.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 ); // $ExpectError - random( 10, true, 5.0 ); // $ExpectError - random( 10, false, 5.0 ); // $ExpectError - random( 10, null, 5.0 ); // $ExpectError - random( 10, [], 5.0 ); // $ExpectError - random( 10, {}, 5.0 ); // $ExpectError - random( 10, ( x: number ): number => x, 5.0 ); // $ExpectError - - random( 10, '5', 5.0, {} ); // $ExpectError - random( 10, true, 5.0, {} ); // $ExpectError - random( 10, false, 5.0, {} ); // $ExpectError - random( 10, null, 5.0, {} ); // $ExpectError - random( 10, [], 5.0, {} ); // $ExpectError - random( 10, {}, 5.0, {} ); // $ExpectError - random( 10, ( x: number ): number => x, 5.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' ); // $ExpectError - random( 10, 2.0, true ); // $ExpectError - random( 10, 2.0, false ); // $ExpectError - random( 10, 2.0, null ); // $ExpectError - random( 10, 2.0, [] ); // $ExpectError - random( 10, 2.0, {} ); // $ExpectError - random( 10, 2.0, ( x: number ): number => x ); // $ExpectError - - random( 10, 2.0, '5', {} ); // $ExpectError - random( 10, 2.0, true, {} ); // $ExpectError - random( 10, 2.0, false, {} ); // $ExpectError - random( 10, 2.0, null, {} ); // $ExpectError - random( 10, 2.0, [], {} ); // $ExpectError - random( 10, 2.0, {}, {} ); // $ExpectError - random( 10, 2.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, '5' ); // $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, [] ); // $ExpectError - random( 10, 2.0, 5.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, { 'dtype': 123 } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': null } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - random( 10, 2.0, 5.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 -} - -// Attached to the main export is an `assign` method which returns an array... -{ - const x = zeros( 10, 'float64' ); - - random.assign( 2.0, 5.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, x ); // $ExpectError - random.assign( true, 5.0, x ); // $ExpectError - random.assign( false, 5.0, x ); // $ExpectError - random.assign( null, 5.0, x ); // $ExpectError - random.assign( [], 5.0, x ); // $ExpectError - random.assign( {}, 5.0, x ); // $ExpectError - random.assign( ( x: number ): number => x, 5.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', x ); // $ExpectError - random.assign( 2.0, true, x ); // $ExpectError - random.assign( 2.0, false, x ); // $ExpectError - random.assign( 2.0, null, x ); // $ExpectError - random.assign( 2.0, [], x ); // $ExpectError - random.assign( 2.0, {}, x ); // $ExpectError - random.assign( 2.0, ( x: number ): number => x, x ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid output array... -{ - random.assign( 2.0, 5.0, '5' ); // $ExpectError - random.assign( 2.0, 5.0, 5 ); // $ExpectError - random.assign( 2.0, 5.0, true ); // $ExpectError - random.assign( 2.0, 5.0, false ); // $ExpectError - random.assign( 2.0, 5.0, null ); // $ExpectError - random.assign( 2.0, 5.0, {} ); // $ExpectError - random.assign( 2.0, 5.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const 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 -} - -// Attached to main export is a `factory` method which returns a function... -{ - random.factory( 2.0, 5.0 ); // $ExpectType UnaryFunction - random.factory( 2.0, 5.0, { 'copy': false } ); // $ExpectType UnaryFunction - - random.factory(); // $ExpectType TernaryFunction - random.factory( { 'copy': false } ); // $ExpectType TernaryFunction -} - -// The `factory` method returns a function which returns an array... -{ - const fcn1 = random.factory( 2.0, 5.0 ); - fcn1( 10 ); // $ExpectType RandomArray - - const fcn2 = random.factory(); - fcn2( 10, 2.0, 5.0 ); // $ExpectType RandomArray -} - -// The compiler throws an error if the `factory` method is provided invalid arguments... -{ - random.factory( '5', 5.0 ); // $ExpectError - random.factory( true, 5.0 ); // $ExpectError - random.factory( false, 5.0 ); // $ExpectError - random.factory( [], 5.0 ); // $ExpectError - random.factory( {}, 5.0 ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0 ); // $ExpectError - - random.factory( '5', 5.0, {} ); // $ExpectError - random.factory( true, 5.0, {} ); // $ExpectError - random.factory( false, 5.0, {} ); // $ExpectError - random.factory( [], 5.0, {} ); // $ExpectError - random.factory( {}, 5.0, {} ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0, {} ); // $ExpectError - - random.factory( 2.0, '5' ); // $ExpectError - random.factory( 2.0, true ); // $ExpectError - random.factory( 2.0, false ); // $ExpectError - random.factory( 2.0, [] ); // $ExpectError - random.factory( 2.0, {} ); // $ExpectError - random.factory( 2.0, ( x: number ): number => x ); // $ExpectError - - random.factory( 2.0, '5', {} ); // $ExpectError - random.factory( 2.0, true, {} ); // $ExpectError - random.factory( 2.0, false, {} ); // $ExpectError - random.factory( 2.0, [], {} ); // $ExpectError - random.factory( 2.0, {}, {} ); // $ExpectError - random.factory( 2.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, 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, { 'prng': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'seed': true } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': [ 'a' ] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'state': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': {} } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': true } ); // $ExpectError - random.factory( 2.0, 5.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, { 'copy': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'dtype': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - random.factory( 2.0, 5.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, {}, {} ); // $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 ); - 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 ); // $ExpectError - fcn2( false, 2.0, 5.0 ); // $ExpectError - fcn2( '5', 2.0, 5.0 ); // $ExpectError - fcn2( [], 2.0, 5.0 ); // $ExpectError - fcn2( {}, 2.0, 5.0 ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - fcn2( true, 2.0, 5.0, {} ); // $ExpectError - fcn2( false, 2.0, 5.0, {} ); // $ExpectError - fcn2( '5', 2.0, 5.0, {} ); // $ExpectError - fcn2( [], 2.0, 5.0, {} ); // $ExpectError - fcn2( {}, 2.0, 5.0, {} ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0, {} ); // $ExpectError - - fcn2( 10, true, 5.0 ); // $ExpectError - fcn2( 10, false, 5.0 ); // $ExpectError - fcn2( 10, '5', 5.0 ); // $ExpectError - fcn2( 10, [], 5.0 ); // $ExpectError - fcn2( 10, {}, 5.0 ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0 ); // $ExpectError - - fcn2( 10, true, 5.0, {} ); // $ExpectError - fcn2( 10, false, 5.0, {} ); // $ExpectError - fcn2( 10, '5', 5.0, {} ); // $ExpectError - fcn2( 10, [], 5.0, {} ); // $ExpectError - fcn2( 10, {}, 5.0, {} ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0, {} ); // $ExpectError - - fcn2( 10, 2.0, true ); // $ExpectError - fcn2( 10, 2.0, false ); // $ExpectError - fcn2( 10, 2.0, '5' ); // $ExpectError - fcn2( 10, 2.0, [] ); // $ExpectError - fcn2( 10, 2.0, {} ); // $ExpectError - fcn2( 10, 2.0, ( x: number ): number => x ); // $ExpectError - - fcn2( 10, 2.0, true, {} ); // $ExpectError - fcn2( 10, 2.0, false, {} ); // $ExpectError - fcn2( 10, 2.0, '5', {} ); // $ExpectError - fcn2( 10, 2.0, [], {} ); // $ExpectError - fcn2( 10, 2.0, {}, {} ); // $ExpectError - fcn2( 10, 2.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, { 'dtype': 123 } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': null } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError - - const fcn2 = random.factory( 2.0, 5.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 ); - fcn1(); // $ExpectError - fcn1( 1, 1, 1 ); // $ExpectError - - const fcn2 = random.factory(); - fcn2(); // $ExpectError - fcn2( 1 ); // $ExpectError - fcn2( 1, 1, 1, 1 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index c485546..0000000 --- a/examples/index.js +++ /dev/null @@ -1,48 +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'; - -var logEach = require( '@stdlib/console-log-each' ); -var uniform = require( './../lib' ); - -// Create a function for generating random arrays originating from the same state: -var random = uniform.factory( 2.0, 5.0, { - 'state': uniform.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 = uniform.factory( 2.0, 5.0, { - 'state': uniform.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 9a727e8..2935269 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..2ee72f2 --- /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-binary-factory@v0.2.2-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtypes@v0.3.0-esm/index.mjs";import r 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-uniform@v0.2.1-esm/index.mjs";var d=e(n,s("real_floating_point_and_generic"),r.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..ab36cb6 --- /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) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 binaryFactory from '@stdlib/random-array-tools-binary-factory';\nimport dtypes from '@stdlib/array-dtypes';\nimport defaults from '@stdlib/array-defaults';\nimport base from '@stdlib/random-base-uniform';\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 continuous uniform distribution.\n*\n* @name factory\n* @type {Function}\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\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} 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 uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10 );\n* // returns \n*\n* @example\n* var uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar factory = binaryFactory( 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) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution.\n*\n* @name uniform\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\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 = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar uniform = factory();\n\n\n// EXPORTS //\n\nexport default uniform;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution.\n*\n* @module @stdlib/random-array-uniform\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.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","binaryFactory","base","dtypes","defaults","get","uniform","setReadOnly","main"],"mappings":";;kfA8BA,IAyCIA,EAAUC,EAAeC,EAzChBC,EAAQ,mCAyCsBC,EAASC,IAAK,+BCnBrDC,EAAUN,ICiBdO,EAAAC,EAAA,UAAAR"} \ No newline at end of file diff --git a/lib/factory.js b/lib/factory.js deleted file mode 100644 index 79da171..0000000 --- a/lib/factory.js +++ /dev/null @@ -1,77 +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 binaryFactory = require( '@stdlib/random-array-tools-binary-factory' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var defaults = require( '@stdlib/array-defaults' ); -var base = require( '@stdlib/random-base-uniform' ); - - -// VARIABLES // - -var DTYPES = dtypes( 'real_floating_point_and_generic' ); - - -// MAIN // - -/** -* Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution. -* -* @name factory -* @type {Function} -* @param {number} [a] - minimum support -* @param {number} [b] - maximum support -* @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} 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 uniform = factory( 2.0, 5.0 ); -* // returns -* -* var arr = uniform( 10 ); -* // returns -* -* @example -* var uniform = factory( 2.0, 5.0 ); -* // returns -* -* var arr = uniform( 10, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -var factory = binaryFactory( 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 3376c12..0000000 --- a/lib/index.js +++ /dev/null @@ -1,77 +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'; - -/** -* Create an array containing pseudorandom numbers drawn from a continuous uniform distribution. -* -* @module @stdlib/random-array-uniform -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var arr = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var arr = uniform( 10, 2.0, 5.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var rand = uniform.factory( 2.0, 5.0 ); -* // returns -* -* var arr = rand( 10 ); -* // returns -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var rand = uniform.factory( 2.0, 5.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 f93ef8f..0000000 --- a/lib/main.js +++ /dev/null @@ -1,58 +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 factory = require( './factory.js' ); - - -// MAIN // - -/** -* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution. -* -* @name uniform -* @type {Function} -* @param {NonNegativeInteger} len - array length -* @param {number} a - minimum support -* @param {number} b - maximum support -* @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 = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var arr = uniform( 10, 2.0, 5.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -var uniform = factory(); - - -// EXPORTS // - -module.exports = uniform; diff --git a/package.json b/package.json index 5348d95..78b1595 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 continuous uniform 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-binary-factory": "^0.2.2", - "@stdlib/random-base-uniform": "^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..781ee7c --- /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 14d34c7..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, 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, 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, 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, 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 765abb1..0000000 --- a/test/test.factory.js +++ /dev/null @@ -1,1261 +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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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, 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, { - '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, { - '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, { - '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, { - '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, { - '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, { - '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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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 ); - - 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 ); - - 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, { - '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 ); - - 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 ); - 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 ); - - 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 ); - - 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 ); - - 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 ); - - 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, { - '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 ); - - 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, { - '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 ); - - 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, { - '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 ); - - 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, { - '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 ); - - 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, { - '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, { - '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 ); - - // 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, { - '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 ); - - // 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, { - '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 ); - - 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, { - 'prng': randu.normalized - }); - - randu = minstd.factory({ - 'seed': seed - }); - random2 = factory( 2.0, 5.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 ); - arr2 = random2( 10, 2.0, 5.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 4e0f74d..0000000 --- a/test/test.js +++ /dev/null @@ -1,74 +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 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 faf9d84..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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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, 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, { - '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 ); - - 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, { - '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, { - '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, { - '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 ); - } - // Capture the current state: - state = random.state; - - // Move to a future state... - arr = random( 10, 2.0, 5.0 ); - for ( i = 0; i < 100; i++ ) { - random( 2, 2.0, 5.0 ); - } - // Set the state: - random.state = state; - - // Replay previously generated values: - t.deepEqual( random( 10, 2.0, 5.0 ), arr, 'returns expected value' ); - - t.end(); -}); From 4814280233d20d82e90e428a680e473e3e33027c Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 14 Apr 2025 00:39:46 +0000 Subject: [PATCH 80/82] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index bd9e800..5348d95 100644 --- a/package.json +++ b/package.json @@ -42,7 +42,8 @@ "@stdlib/random-array-tools-binary-factory": "^0.2.2", "@stdlib/random-base-uniform": "^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 f0e378a2611c7e08ad8efac2c5d712c403ada6e6 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 14 Apr 2025 00:43:12 +0000 Subject: [PATCH 81/82] Remove files --- index.d.ts | 279 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5126 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 2935269..0000000 --- a/index.d.ts +++ /dev/null @@ -1,279 +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. -*/ - -// 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 continuous uniform distribution with pre-specified parameter values. -*/ -interface UnaryFunction extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform 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 continuous uniform distribution. - * - * @param out - output array - * @returns output array - */ - assign( out: RandomArray ): RandomArray; -} - -/** -* Interface for generating pseudorandom numbers drawn from a continuous uniform distribution without pre-specified parameter values. -*/ -interface TernaryFunction extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution. - * - * @param len - array length - * @param a - minimum support - * @param b - maximum support - * @param options - function options - * @returns output array - */ - ( len: number, a: number, b: number, options?: Options ): RandomArray; - - /** - * Fills an array with pseudorandom numbers drawn from a continuous uniform distribution. - * - * @param a - minimum support - * @param b - maximum support - * @param out - output array - * @returns output array - */ - assign( a: number, b: number, out: RandomArray ): RandomArray; -} - -/** -* Interface for generating pseudorandom numbers drawn from a continuous uniform distribution. -*/ -interface Random extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution. - * - * @param len - array length - * @param a - minimum support - * @param b - maximum support - * @param options - function options - * @returns output array - * - * @example - * var out = uniform( 10, 2.0, 5.0 ); - * // returns - */ - ( len: number, a: number, b: number, options?: Options ): RandomArray; - - /** - * Fills an array with pseudorandom numbers drawn from a continuous uniform distribution. - * - * @param a - minimum support - * @param b - maximum support - * @param out - output array - * @returns output array - * - * @example - * var zeros = require( '@stdlib/array-zeros' ); - * - * var x = zeros( 10, 'float64' ); - * // returns - * - * var out = uniform( 2.0, 5.0, out ); - * // returns - * - * var bool = ( out === x ); - * // returns true - */ - assign( a: number, b: number, out: RandomArray ): RandomArray; - - /** - * Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform 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 options - function options - * @throws must provide a valid state - * @returns function for creating arrays - * - * @example - * var random = uniform.factory( 2.0, 5.0 ); - * - * var out = random( 10 ); - * // returns - * - * @example - * var random = uniform.factory( 2.0, 5.0, { - * 'seed': 297 - * }); - * var out = random( 10 ); - * // returns - */ - factory( a: number, b: number, options?: FactoryOptions ): UnaryFunction; - - /** - * Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform 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 = uniform.factory(); - * - * var out = random( 10, 2.0, 5.0 ); - * // returns - * - * @example - * var random = uniform.factory({ - * 'seed': 297 - * }); - * var out = random( 10, 2.0, 5.0 ); - * // returns - */ - factory( options?: FactoryOptions ): TernaryFunction; -} - -/** -* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution. -* -* @param len - array length -* @param a - minimum support -* @param b - maximum support -* @param options - function options -* @returns output array -* -* @example -* var out = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var random = uniform.factory( 2.0, 5.0 ); -* -* var out = random( 10 ); -* // returns -*/ -declare var uniform: Random; - - -// EXPORTS // - -export = uniform; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 2ee72f2..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-binary-factory@v0.2.2-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtypes@v0.3.0-esm/index.mjs";import r 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-uniform@v0.2.1-esm/index.mjs";var d=e(n,s("real_floating_point_and_generic"),r.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 ab36cb6..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) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 binaryFactory from '@stdlib/random-array-tools-binary-factory';\nimport dtypes from '@stdlib/array-dtypes';\nimport defaults from '@stdlib/array-defaults';\nimport base from '@stdlib/random-base-uniform';\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 continuous uniform distribution.\n*\n* @name factory\n* @type {Function}\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\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} 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 uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10 );\n* // returns \n*\n* @example\n* var uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar factory = binaryFactory( 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) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution.\n*\n* @name uniform\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\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 = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar uniform = factory();\n\n\n// EXPORTS //\n\nexport default uniform;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution.\n*\n* @module @stdlib/random-array-uniform\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.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","binaryFactory","base","dtypes","defaults","get","uniform","setReadOnly","main"],"mappings":";;kfA8BA,IAyCIA,EAAUC,EAAeC,EAzChBC,EAAQ,mCAyCsBC,EAASC,IAAK,+BCnBrDC,EAAUN,ICiBdO,EAAAC,EAAA,UAAAR"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 781ee7c..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From ad987c6e561e4cd13851df162405f8c6b5f92a32 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 14 Apr 2025 00:43:28 +0000 Subject: [PATCH 82/82] 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 | 170 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 69 +- 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 | 198 - docs/types/test.ts | 409 -- examples/index.js | 48 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/factory.js | 77 - lib/index.js | 77 - lib/main.js | 58 - package.json | 71 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 118 - test/test.factory.js | 1261 ----- test/test.js | 74 - test/test.main.js | 244 - 56 files changed, 4884 insertions(+), 7107 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 e60a8dc..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2025-04-14T00:39:20.455Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 76a6357..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/uniform) 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 5097056..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/uniform) 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 31ea6a7..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: '33 9 * * 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,19 +468,19 @@ Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/random-array-uniform/main/LICENSE -[@stdlib/random/base/uniform]: https://github.com/stdlib-js/random-base-uniform +[@stdlib/random/base/uniform]: https://github.com/stdlib-js/random-base-uniform/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 -[@stdlib/random/array/discrete-uniform]: https://github.com/stdlib-js/random-array-discrete-uniform +[@stdlib/random/array/discrete-uniform]: https://github.com/stdlib-js/random-array-discrete-uniform/tree/esm -[@stdlib/random/strided/uniform]: https://github.com/stdlib-js/random-strided-uniform +[@stdlib/random/strided/uniform]: https://github.com/stdlib-js/random-strided-uniform/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 4923816..0000000 --- a/benchmark/benchmark.float32.assign.js +++ /dev/null @@ -1,97 +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 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, 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 dea0644..0000000 --- a/benchmark/benchmark.float32.factory.js +++ /dev/null @@ -1,96 +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 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, { - '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 4249752..0000000 --- a/benchmark/benchmark.float32.js +++ /dev/null @@ -1,98 +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 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, 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 8cf1538..0000000 --- a/benchmark/benchmark.float64.assign.js +++ /dev/null @@ -1,97 +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 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, 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 f352bca..0000000 --- a/benchmark/benchmark.float64.factory.js +++ /dev/null @@ -1,96 +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 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, { - '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 e176e0a..0000000 --- a/benchmark/benchmark.float64.js +++ /dev/null @@ -1,98 +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 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, 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 6038ee7..0000000 --- a/benchmark/benchmark.generic.assign.js +++ /dev/null @@ -1,97 +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 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, 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 6a6bddc..0000000 --- a/benchmark/benchmark.generic.factory.js +++ /dev/null @@ -1,96 +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 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, { - '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 b6bdcfd..0000000 --- a/benchmark/benchmark.generic.js +++ /dev/null @@ -1,98 +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 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, 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 5a79fd6..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/uniform" -%% click B href "https://github.com/stdlib-js/random-array-uniform/tree/main" -%% click C href "https://github.com/stdlib-js/random-array-uniform/tree/production" -%% click D href "https://github.com/stdlib-js/random-array-uniform/tree/esm" -%% click E href "https://github.com/stdlib-js/random-array-uniform/tree/deno" -%% click F href "https://github.com/stdlib-js/random-array-uniform/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/uniform -[production-url]: https://github.com/stdlib-js/random-array-uniform/tree/production -[deno-url]: https://github.com/stdlib-js/random-array-uniform/tree/deno -[deno-readme]: https://github.com/stdlib-js/random-array-uniform/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/random-array-uniform/tree/umd -[umd-readme]: https://github.com/stdlib-js/random-array-uniform/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/random-array-uniform/tree/esm -[esm-readme]: https://github.com/stdlib-js/random-array-uniform/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 f2a679f..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import uniform from '../docs/types/index'; -export = uniform; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index f49a668..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var a=function(u,r){return function(){return r||u((r={exports:{}}).exports,r),r.exports}};var e=a(function(x,t){ -var v=require('@stdlib/random-array-tools-binary-factory/dist'),n=require('@stdlib/array-dtypes/dist'),c=require('@stdlib/array-defaults/dist'),y=require('@stdlib/random-base-uniform/dist'),f=n("real_floating_point_and_generic"),q=v(y,f,c.get("dtypes.real_floating_point"));t.exports=q -});var s=a(function(b,i){ -var p=e(),l=p();i.exports=l -});var _=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),o=s(),d=e();_(o,"factory",d);module.exports=o; -/** @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 815b1ac..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) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 binaryFactory = require( '@stdlib/random-array-tools-binary-factory' );\nvar dtypes = require( '@stdlib/array-dtypes' );\nvar defaults = require( '@stdlib/array-defaults' );\nvar base = require( '@stdlib/random-base-uniform' );\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 continuous uniform distribution.\n*\n* @name factory\n* @type {Function}\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\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} 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 uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10 );\n* // returns \n*\n* @example\n* var uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar factory = binaryFactory( 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) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution.\n*\n* @name uniform\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\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 = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar uniform = factory();\n\n\n// EXPORTS //\n\nmodule.exports = uniform;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution.\n*\n* @module @stdlib/random-array-uniform\n*\n* @example\n* var uniform = require( '@stdlib/random-array-uniform' );\n*\n* var arr = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var uniform = require( '@stdlib/random-array-uniform' );\n*\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* var uniform = require( '@stdlib/random-array-uniform' );\n*\n* var rand = uniform.factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* var uniform = require( '@stdlib/random-array-uniform' );\n*\n* var rand = uniform.factory( 2.0, 5.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,EAAgB,QAAS,2CAA4C,EACrEC,EAAS,QAAS,sBAAuB,EACzCC,EAAW,QAAS,wBAAyB,EAC7CC,EAAO,QAAS,6BAA8B,EAK9CC,EAASH,EAAQ,iCAAkC,EAyCnDI,EAAUL,EAAeG,EAAMC,EAAQF,EAAS,IAAK,4BAA6B,CAAE,EAKxFH,EAAO,QAAUM,IC5EjB,IAAAC,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,IA8BVC,EAAUD,EAAQ,EAKtBD,EAAO,QAAUE,ICKjB,IAAIC,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAU,IAKdF,EAAaC,EAAM,UAAWC,CAAQ,EAKtC,OAAO,QAAUD", - "names": ["require_factory", "__commonJSMin", "exports", "module", "binaryFactory", "dtypes", "defaults", "base", "DTYPES", "factory", "require_main", "__commonJSMin", "exports", "module", "factory", "uniform", "setReadOnly", "main", "factory"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index af6976c..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,198 +0,0 @@ - -{{alias}}( len, a, b[, options] ) - Returns an array containing pseudorandom numbers drawn from a continuous - uniform distribution. - - Parameters - ---------- - len: integer - Output array length. - - a: number - Minimum support. - - b: number - Maximum support. - - 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 ) - - - -{{alias}}.assign( a, b, out ) - Fills an array with pseudorandom numbers drawn from a continuous uniform - distribution. - - Parameters - ---------- - a: number - Minimum support. - - b: number - Maximum support. - - 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, x ) - - > var bool = ( out === x ) - true - - -{{alias}}.factory( [a, b, ][options] ) - Returns a function for creating arrays containing pseudorandom numbers drawn - from a continuous uniform 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. - - 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 ) - - - // Provide distribution parameters: - > fcn = {{alias}}.factory( 2.0, 5.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 ) - - - // Get a copy of the current state: - > var state = {{alias}}.state - - - > out = {{alias}}( 3, 2.0, 5.0 ) - - > out = {{alias}}( 3, 2.0, 5.0 ) - - - // Set the state: - > {{alias}}.state = state; - - // Regenerate a previous array: - > out = {{alias}}( 3, 2.0, 5.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 9e8939e..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,409 +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. -*/ - -import zeros = require( '@stdlib/array-zeros' ); -import random = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - random( 10, 2.0, 5.0 ); // $ExpectType RandomArray - random( 10, 2.0, 5.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 ); // $ExpectError - random( true, 2.0, 5.0 ); // $ExpectError - random( false, 2.0, 5.0 ); // $ExpectError - random( null, 2.0, 5.0 ); // $ExpectError - random( [], 2.0, 5.0 ); // $ExpectError - random( {}, 2.0, 5.0 ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - random( '5', 2.0, 5.0, {} ); // $ExpectError - random( true, 2.0, 5.0, {} ); // $ExpectError - random( false, 2.0, 5.0, {} ); // $ExpectError - random( null, 2.0, 5.0, {} ); // $ExpectError - random( [], 2.0, 5.0, {} ); // $ExpectError - random( {}, 2.0, 5.0, {} ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.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 ); // $ExpectError - random( 10, true, 5.0 ); // $ExpectError - random( 10, false, 5.0 ); // $ExpectError - random( 10, null, 5.0 ); // $ExpectError - random( 10, [], 5.0 ); // $ExpectError - random( 10, {}, 5.0 ); // $ExpectError - random( 10, ( x: number ): number => x, 5.0 ); // $ExpectError - - random( 10, '5', 5.0, {} ); // $ExpectError - random( 10, true, 5.0, {} ); // $ExpectError - random( 10, false, 5.0, {} ); // $ExpectError - random( 10, null, 5.0, {} ); // $ExpectError - random( 10, [], 5.0, {} ); // $ExpectError - random( 10, {}, 5.0, {} ); // $ExpectError - random( 10, ( x: number ): number => x, 5.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' ); // $ExpectError - random( 10, 2.0, true ); // $ExpectError - random( 10, 2.0, false ); // $ExpectError - random( 10, 2.0, null ); // $ExpectError - random( 10, 2.0, [] ); // $ExpectError - random( 10, 2.0, {} ); // $ExpectError - random( 10, 2.0, ( x: number ): number => x ); // $ExpectError - - random( 10, 2.0, '5', {} ); // $ExpectError - random( 10, 2.0, true, {} ); // $ExpectError - random( 10, 2.0, false, {} ); // $ExpectError - random( 10, 2.0, null, {} ); // $ExpectError - random( 10, 2.0, [], {} ); // $ExpectError - random( 10, 2.0, {}, {} ); // $ExpectError - random( 10, 2.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, '5' ); // $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, [] ); // $ExpectError - random( 10, 2.0, 5.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, { 'dtype': 123 } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': null } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - random( 10, 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - random( 10, 2.0, 5.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 -} - -// Attached to the main export is an `assign` method which returns an array... -{ - const x = zeros( 10, 'float64' ); - - random.assign( 2.0, 5.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, x ); // $ExpectError - random.assign( true, 5.0, x ); // $ExpectError - random.assign( false, 5.0, x ); // $ExpectError - random.assign( null, 5.0, x ); // $ExpectError - random.assign( [], 5.0, x ); // $ExpectError - random.assign( {}, 5.0, x ); // $ExpectError - random.assign( ( x: number ): number => x, 5.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', x ); // $ExpectError - random.assign( 2.0, true, x ); // $ExpectError - random.assign( 2.0, false, x ); // $ExpectError - random.assign( 2.0, null, x ); // $ExpectError - random.assign( 2.0, [], x ); // $ExpectError - random.assign( 2.0, {}, x ); // $ExpectError - random.assign( 2.0, ( x: number ): number => x, x ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid output array... -{ - random.assign( 2.0, 5.0, '5' ); // $ExpectError - random.assign( 2.0, 5.0, 5 ); // $ExpectError - random.assign( 2.0, 5.0, true ); // $ExpectError - random.assign( 2.0, 5.0, false ); // $ExpectError - random.assign( 2.0, 5.0, null ); // $ExpectError - random.assign( 2.0, 5.0, {} ); // $ExpectError - random.assign( 2.0, 5.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const 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 -} - -// Attached to main export is a `factory` method which returns a function... -{ - random.factory( 2.0, 5.0 ); // $ExpectType UnaryFunction - random.factory( 2.0, 5.0, { 'copy': false } ); // $ExpectType UnaryFunction - - random.factory(); // $ExpectType TernaryFunction - random.factory( { 'copy': false } ); // $ExpectType TernaryFunction -} - -// The `factory` method returns a function which returns an array... -{ - const fcn1 = random.factory( 2.0, 5.0 ); - fcn1( 10 ); // $ExpectType RandomArray - - const fcn2 = random.factory(); - fcn2( 10, 2.0, 5.0 ); // $ExpectType RandomArray -} - -// The compiler throws an error if the `factory` method is provided invalid arguments... -{ - random.factory( '5', 5.0 ); // $ExpectError - random.factory( true, 5.0 ); // $ExpectError - random.factory( false, 5.0 ); // $ExpectError - random.factory( [], 5.0 ); // $ExpectError - random.factory( {}, 5.0 ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0 ); // $ExpectError - - random.factory( '5', 5.0, {} ); // $ExpectError - random.factory( true, 5.0, {} ); // $ExpectError - random.factory( false, 5.0, {} ); // $ExpectError - random.factory( [], 5.0, {} ); // $ExpectError - random.factory( {}, 5.0, {} ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0, {} ); // $ExpectError - - random.factory( 2.0, '5' ); // $ExpectError - random.factory( 2.0, true ); // $ExpectError - random.factory( 2.0, false ); // $ExpectError - random.factory( 2.0, [] ); // $ExpectError - random.factory( 2.0, {} ); // $ExpectError - random.factory( 2.0, ( x: number ): number => x ); // $ExpectError - - random.factory( 2.0, '5', {} ); // $ExpectError - random.factory( 2.0, true, {} ); // $ExpectError - random.factory( 2.0, false, {} ); // $ExpectError - random.factory( 2.0, [], {} ); // $ExpectError - random.factory( 2.0, {}, {} ); // $ExpectError - random.factory( 2.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, 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, { 'prng': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'prng': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'seed': true } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': [ 'a' ] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'seed': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'state': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': {} } ); // $ExpectError - random.factory( 2.0, 5.0, { 'state': true } ); // $ExpectError - random.factory( 2.0, 5.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, { 'copy': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'copy': {} } ); // $ExpectError - random.factory( 2.0, 5.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, { 'dtype': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': null } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - random.factory( 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - random.factory( 2.0, 5.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, {}, {} ); // $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 ); - 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 ); // $ExpectError - fcn2( false, 2.0, 5.0 ); // $ExpectError - fcn2( '5', 2.0, 5.0 ); // $ExpectError - fcn2( [], 2.0, 5.0 ); // $ExpectError - fcn2( {}, 2.0, 5.0 ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - fcn2( true, 2.0, 5.0, {} ); // $ExpectError - fcn2( false, 2.0, 5.0, {} ); // $ExpectError - fcn2( '5', 2.0, 5.0, {} ); // $ExpectError - fcn2( [], 2.0, 5.0, {} ); // $ExpectError - fcn2( {}, 2.0, 5.0, {} ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0, {} ); // $ExpectError - - fcn2( 10, true, 5.0 ); // $ExpectError - fcn2( 10, false, 5.0 ); // $ExpectError - fcn2( 10, '5', 5.0 ); // $ExpectError - fcn2( 10, [], 5.0 ); // $ExpectError - fcn2( 10, {}, 5.0 ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0 ); // $ExpectError - - fcn2( 10, true, 5.0, {} ); // $ExpectError - fcn2( 10, false, 5.0, {} ); // $ExpectError - fcn2( 10, '5', 5.0, {} ); // $ExpectError - fcn2( 10, [], 5.0, {} ); // $ExpectError - fcn2( 10, {}, 5.0, {} ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0, {} ); // $ExpectError - - fcn2( 10, 2.0, true ); // $ExpectError - fcn2( 10, 2.0, false ); // $ExpectError - fcn2( 10, 2.0, '5' ); // $ExpectError - fcn2( 10, 2.0, [] ); // $ExpectError - fcn2( 10, 2.0, {} ); // $ExpectError - fcn2( 10, 2.0, ( x: number ): number => x ); // $ExpectError - - fcn2( 10, 2.0, true, {} ); // $ExpectError - fcn2( 10, 2.0, false, {} ); // $ExpectError - fcn2( 10, 2.0, '5', {} ); // $ExpectError - fcn2( 10, 2.0, [], {} ); // $ExpectError - fcn2( 10, 2.0, {}, {} ); // $ExpectError - fcn2( 10, 2.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, { 'dtype': 123 } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': 'abc' } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': null } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - fcn1( 2.0, 5.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError - - const fcn2 = random.factory( 2.0, 5.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 ); - fcn1(); // $ExpectError - fcn1( 1, 1, 1 ); // $ExpectError - - const fcn2 = random.factory(); - fcn2(); // $ExpectError - fcn2( 1 ); // $ExpectError - fcn2( 1, 1, 1, 1 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index c485546..0000000 --- a/examples/index.js +++ /dev/null @@ -1,48 +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'; - -var logEach = require( '@stdlib/console-log-each' ); -var uniform = require( './../lib' ); - -// Create a function for generating random arrays originating from the same state: -var random = uniform.factory( 2.0, 5.0, { - 'state': uniform.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 = uniform.factory( 2.0, 5.0, { - 'state': uniform.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 9a727e8..2935269 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..2ee72f2 --- /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-binary-factory@v0.2.2-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtypes@v0.3.0-esm/index.mjs";import r 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-uniform@v0.2.1-esm/index.mjs";var d=e(n,s("real_floating_point_and_generic"),r.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..ab36cb6 --- /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) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 binaryFactory from '@stdlib/random-array-tools-binary-factory';\nimport dtypes from '@stdlib/array-dtypes';\nimport defaults from '@stdlib/array-defaults';\nimport base from '@stdlib/random-base-uniform';\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 continuous uniform distribution.\n*\n* @name factory\n* @type {Function}\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\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} 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 uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10 );\n* // returns \n*\n* @example\n* var uniform = factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = uniform( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar factory = binaryFactory( 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) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution.\n*\n* @name uniform\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\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 = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar uniform = factory();\n\n\n// EXPORTS //\n\nexport default uniform;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 continuous uniform distribution.\n*\n* @module @stdlib/random-array-uniform\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var arr = uniform( 10, 2.0, 5.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* import uniform from '@stdlib/random-array-uniform';\n*\n* var rand = uniform.factory( 2.0, 5.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","binaryFactory","base","dtypes","defaults","get","uniform","setReadOnly","main"],"mappings":";;kfA8BA,IAyCIA,EAAUC,EAAeC,EAzChBC,EAAQ,mCAyCsBC,EAASC,IAAK,+BCnBrDC,EAAUN,ICiBdO,EAAAC,EAAA,UAAAR"} \ No newline at end of file diff --git a/lib/factory.js b/lib/factory.js deleted file mode 100644 index 79da171..0000000 --- a/lib/factory.js +++ /dev/null @@ -1,77 +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 binaryFactory = require( '@stdlib/random-array-tools-binary-factory' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var defaults = require( '@stdlib/array-defaults' ); -var base = require( '@stdlib/random-base-uniform' ); - - -// VARIABLES // - -var DTYPES = dtypes( 'real_floating_point_and_generic' ); - - -// MAIN // - -/** -* Returns a function for creating arrays containing pseudorandom numbers drawn from a continuous uniform distribution. -* -* @name factory -* @type {Function} -* @param {number} [a] - minimum support -* @param {number} [b] - maximum support -* @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} 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 uniform = factory( 2.0, 5.0 ); -* // returns -* -* var arr = uniform( 10 ); -* // returns -* -* @example -* var uniform = factory( 2.0, 5.0 ); -* // returns -* -* var arr = uniform( 10, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -var factory = binaryFactory( 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 3376c12..0000000 --- a/lib/index.js +++ /dev/null @@ -1,77 +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'; - -/** -* Create an array containing pseudorandom numbers drawn from a continuous uniform distribution. -* -* @module @stdlib/random-array-uniform -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var arr = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var arr = uniform( 10, 2.0, 5.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var rand = uniform.factory( 2.0, 5.0 ); -* // returns -* -* var arr = rand( 10 ); -* // returns -* -* @example -* var uniform = require( '@stdlib/random-array-uniform' ); -* -* var rand = uniform.factory( 2.0, 5.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 f93ef8f..0000000 --- a/lib/main.js +++ /dev/null @@ -1,58 +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 factory = require( './factory.js' ); - - -// MAIN // - -/** -* Returns an array containing pseudorandom numbers drawn from a continuous uniform distribution. -* -* @name uniform -* @type {Function} -* @param {NonNegativeInteger} len - array length -* @param {number} a - minimum support -* @param {number} b - maximum support -* @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 = uniform( 10, 2.0, 5.0 ); -* // returns -* -* @example -* var arr = uniform( 10, 2.0, 5.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -var uniform = factory(); - - -// EXPORTS // - -module.exports = uniform; diff --git a/package.json b/package.json index 5348d95..78b1595 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 continuous uniform 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-binary-factory": "^0.2.2", - "@stdlib/random-base-uniform": "^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..781ee7c --- /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 14d34c7..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, 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, 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, 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, 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 765abb1..0000000 --- a/test/test.factory.js +++ /dev/null @@ -1,1261 +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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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, 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, { - '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, { - '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, { - '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, { - '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, { - '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, { - '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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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 ); - - 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 ); - - 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, { - '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 ); - - 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 ); - 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 ); - - 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 ); - - 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 ); - - 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 ); - - 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, { - '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 ); - - 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, { - '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 ); - - 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, { - '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 ); - - 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, { - '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 ); - - 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, { - '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, { - '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 ); - - // 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, { - '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 ); - - // 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, { - '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 ); - - 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, { - 'prng': randu.normalized - }); - - randu = minstd.factory({ - 'seed': seed - }); - random2 = factory( 2.0, 5.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 ); - arr2 = random2( 10, 2.0, 5.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 4e0f74d..0000000 --- a/test/test.js +++ /dev/null @@ -1,74 +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 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 faf9d84..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 ); - }; - } -}); - -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, {} ); - }; - } -}); - -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, 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, { - '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 ); - - 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, { - '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, { - '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, { - '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 ); - } - // Capture the current state: - state = random.state; - - // Move to a future state... - arr = random( 10, 2.0, 5.0 ); - for ( i = 0; i < 100; i++ ) { - random( 2, 2.0, 5.0 ); - } - // Set the state: - random.state = state; - - // Replay previously generated values: - t.deepEqual( random( 10, 2.0, 5.0 ), arr, 'returns expected value' ); - - t.end(); -});