From 0c0e37081d6ef018f3e397d6997547222c9f2b0f Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 26 Jun 2026 07:59:39 +0000 Subject: [PATCH 01/11] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 0177c84..d6f3604 100644 --- a/package.json +++ b/package.json @@ -56,7 +56,7 @@ "@stdlib/ndarray-shape": "^0.2.3", "@stdlib/ndarray-to-array": "^0.2.2", "@stdlib/random-array-discrete-uniform": "^0.2.2", - "@stdlib/string-format": "^0.2.3", + "@stdlib/error-tools-fmtprodmsg": "^0.2.3", "tape": "git+https://github.com/kgryte/tape.git#fix/globby", "istanbul": "^0.4.1", "tap-min": "git+https://github.com/Planeshifter/tap-min.git", From eae868e43bf446026b518896f52a33c9a3d1b44a Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 26 Jun 2026 08:00:26 +0000 Subject: [PATCH 02/11] Auto-generated commit --- .editorconfig | 189 - .eslintrc.js | 1 - .gitattributes | 68 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 821 --- .github/workflows/publish.yml | 261 - .github/workflows/test.yml | 101 - .github/workflows/test_bundles.yml | 213 - .github/workflows/test_coverage.yml | 142 - .github/workflows/test_install.yml | 94 - .github/workflows/test_published_package.yml | 115 - .gitignore | 204 - .npmignore | 229 - .npmrc | 44 - CHANGELOG.md | 49 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 63 +- SECURITY.md | 5 - benchmark/benchmark.js | 47 - benchmark/benchmark.size.js | 95 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 361 -- docs/types/test.ts | 100 - examples/index.js | 51 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 122 - lib/main.js | 131 - package.json | 68 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 1394 ----- 44 files changed, 4877 insertions(+), 5972 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .github/workflows/test_published_package.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/benchmark.size.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 (99%) create mode 100644 index.mjs create mode 100644 index.mjs.map 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.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 80f3fca..0000000 --- a/.editorconfig +++ /dev/null @@ -1,189 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim. - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Ignore generated lock files for GitHub Agentic Workflows: -[*.lock.yml] -charset = unset -end_of_line = unset -indent_style = unset -indent_size = unset -trim_trailing_whitespace = unset -insert_final_newline = unset - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 24b327f..0000000 --- a/.gitattributes +++ /dev/null @@ -1,68 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation - -.github/workflows/*.lock.yml linguist-generated=true merge=ours diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 13e3774..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/ndarray/matrix/float32) 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 6686a6b..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/ndarray/matrix/float32) 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 bfaf214..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: '2 2 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 83d50c4..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,821 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send notification to Zulip if job fails: - - name: 'Send notification to Zulip in case of failure' - # Pin action to full length commit SHA - uses: zulip/github-actions-zulip/send-message@e4c8f27c732ba9bd98ac6be0583096dea82feea5 # v1.0.2 - if: failure() - with: - api-key: ${{ secrets.ZULIP_API_KEY }} - email: 'github-actions-bot@stdlib.zulipchat.com' - organization-url: 'https://stdlib.zulipchat.com' - to: 'workflows-standalone' - type: 'stream' - topic: ${{ github.event.repository.name }} - content: | - :cross_mark: **${{ github.workflow }}** workflow failed - - **Repository:** [${{ github.repository }}](${{ github.server_url }}/${{ github.repository }}) - **Run:** [View workflow run](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}) - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -301,7 +292,7 @@ console.log( ndarray2array( v ) ); ## 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]. @@ -364,9 +355,9 @@ Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-matrix-float32/main/LICENSE -[@stdlib/array/buffer]: https://github.com/stdlib-js/array-buffer +[@stdlib/array/buffer]: https://github.com/stdlib-js/array-buffer/tree/esm -[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor +[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor/tree/esm
diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 03b1296..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,47 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2026 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var pkg = require( './../package.json' ).name; -var Float32Matrix = require( './../lib' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var arr; - var i; - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr = new Float32Matrix( 0, 0 ); - if ( arr.length !== 0 ) { - b.fail( 'should have length 0' ); - } - } - b.toc(); - if ( !isndarrayLike( arr ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.size.js b/benchmark/benchmark.size.js deleted file mode 100644 index 664d979..0000000 --- a/benchmark/benchmark.size.js +++ /dev/null @@ -1,95 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2026 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var Float32Matrix = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveIntegerArray} shape - array shape -* @returns {Function} benchmark function -*/ -function createBenchmark( shape ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var arr; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr = new Float32Matrix( shape ); - if ( typeof arr !== 'object' ) { - b.fail( 'should return an ndarray' ); - } - } - b.toc(); - if ( !isndarrayLike( arr ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var N; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - N = floor( pow( pow( 10, i ), 1.0/2.0 ) ); - f = createBenchmark( [ N, N ] ); - bench( format( '%s::equidimensional:size=%d', pkg, N*N ), f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 7b916fa..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/ndarray/matrix/float32" -%% click B href "https://github.com/stdlib-js/ndarray-matrix-float32/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-matrix-float32/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-matrix-float32/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-matrix-float32/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-matrix-float32/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/matrix/float32 -[production-url]: https://github.com/stdlib-js/ndarray-matrix-float32/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-matrix-float32/tree/deno -[deno-readme]: https://github.com/stdlib-js/ndarray-matrix-float32/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/ndarray-matrix-float32/tree/umd -[umd-readme]: https://github.com/stdlib-js/ndarray-matrix-float32/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/ndarray-matrix-float32/tree/esm -[esm-readme]: https://github.com/stdlib-js/ndarray-matrix-float32/blob/esm/README.md \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index 0b44231..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import ctor from '../docs/types/index'; -export = ctor; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 26cde3c..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var o=function(e,r){return function(){try{return r||e((r={exports:{}}).exports,r),r.exports}catch(i){throw (r=0, i)}};};var a=o(function(v,t){ -var s=require('@stdlib/ndarray-matrix-ctor/dist').factory,c=s("float32");t.exports=c -});var u=a();module.exports=u; -/** @license Apache-2.0 */ -//# sourceMappingURL=index.js.map diff --git a/dist/index.js.map b/dist/index.js.map deleted file mode 100644 index a628c0a..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/main.js", "../lib/index.js"], - "sourcesContent": ["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2026 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* 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( '@stdlib/ndarray-matrix-ctor' ).factory;\n\n\n// MAIN //\n\n/**\n* Returns a single-precision floating-point matrix (i.e., a two-dimensional ndarray).\n*\n* @name Float32Matrix\n* @type {Function}\n* @param {(NonNegativeInteger|NonNegativeIntegerArray|ArrayLikeObject|ArrayBuffer|Iterable)} [arg0] - shape, number of rows, array-like object, ArrayBuffer, or iterable\n* @param {NonNegativeInteger} [arg1] - number of columns or byte offset\n* @param {(NonNegativeInteger|NonNegativeIntegerArray)} [arg2] - shape or number of rows\n* @param {NonNegativeInteger} [arg3] - number of columns\n* @param {Options} [options] - function options\n* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only matrix\n* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed matrix dimensions\n* @param {StringArray} [options.submode=[options.mode]] - specifies how to handle subscripts which exceed array dimensions on a per dimension basis\n* @param {string} [options.order='row-major'] - memory layout (either row-major or column-major)\n* @throws {TypeError} first argument must be either a shape, integer, array-like object, ArrayBuffer, iterable, or options object\n* @throws {TypeError} must provide valid options\n* @returns {ndarray} two-dimensional ndarray\n*\n* @example\n* var getShape = require( '@stdlib/ndarray-shape' );\n*\n* var v = new Float32Matrix();\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 0, 0 ]\n*\n* @example\n* var getShape = require( '@stdlib/ndarray-shape' );\n*\n* var v = new Float32Matrix( [ 2, 2 ] );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 2 ]\n*\n* @example\n* var getShape = require( '@stdlib/ndarray-shape' );\n*\n* var v = new Float32Matrix( 2, 2 );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 2 ]\n*\n* @example\n* var getShape = require( '@stdlib/ndarray-shape' );\n*\n* var v = new Float32Matrix( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 2 ]\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var getShape = require( '@stdlib/ndarray-shape' );\n*\n* var buf = new ArrayBuffer( 32 );\n* var v = new Float32Matrix( buf );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 1, 8 ]\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var getShape = require( '@stdlib/ndarray-shape' );\n*\n* var buf = new ArrayBuffer( 32 );\n* var v = new Float32Matrix( buf, 16 );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 1, 4 ]\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var getShape = require( '@stdlib/ndarray-shape' );\n*\n* var buf = new ArrayBuffer( 64 );\n* var v = new Float32Matrix( buf, 16, [ 2, 1 ] );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 1 ]\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var getShape = require( '@stdlib/ndarray-shape' );\n*\n* var buf = new ArrayBuffer( 64 );\n* var v = new Float32Matrix( buf, 16, 2, 1 );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 1 ]\n*/\nvar Float32Matrix = factory( 'float32' );\n\n\n// EXPORTS //\n\nmodule.exports = Float32Matrix;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2026 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 a single-precision floating-point matrix (i.e., a two-dimensional ndarray).\n*\n* @module @stdlib/ndarray-matrix-float32\n*\n* @example\n* var getShape = require( '@stdlib/ndarray-shape' );\n* var Float32Matrix = require( '@stdlib/ndarray-matrix-float32' );\n*\n* var v = new Float32Matrix();\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 0, 0 ]\n*\n* @example\n* var getShape = require( '@stdlib/ndarray-shape' );\n* var Float32Matrix = require( '@stdlib/ndarray-matrix-float32' );\n*\n* var v = new Float32Matrix( [ 2, 2 ] );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 2 ]\n*\n* @example\n* var getShape = require( '@stdlib/ndarray-shape' );\n* var Float32Matrix = require( '@stdlib/ndarray-matrix-float32' );\n*\n* var v = new Float32Matrix( 2, 2 );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 2 ]\n*\n* @example\n* var getShape = require( '@stdlib/ndarray-shape' );\n* var Float32Matrix = require( '@stdlib/ndarray-matrix-float32' );\n*\n* var v = new Float32Matrix( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 2 ]\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var getShape = require( '@stdlib/ndarray-shape' );\n* var Float32Matrix = require( '@stdlib/ndarray-matrix-float32' );\n*\n* var buf = new ArrayBuffer( 32 );\n* var v = new Float32Matrix( buf );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 1, 8 ]\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var getShape = require( '@stdlib/ndarray-shape' );\n* var Float32Matrix = require( '@stdlib/ndarray-matrix-float32' );\n*\n* var buf = new ArrayBuffer( 32 );\n* var v = new Float32Matrix( buf, 16 );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 1, 4 ]\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var getShape = require( '@stdlib/ndarray-shape' );\n* var Float32Matrix = require( '@stdlib/ndarray-matrix-float32' );\n*\n* var buf = new ArrayBuffer( 64 );\n* var v = new Float32Matrix( buf, 16, [ 2, 1 ] );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 1 ]\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var getShape = require( '@stdlib/ndarray-shape' );\n* var Float32Matrix = require( '@stdlib/ndarray-matrix-float32' );\n*\n* var buf = new ArrayBuffer( 64 );\n* var v = new Float32Matrix( buf, 16, 2, 1 );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 1 ]\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "iIAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,QAAS,6BAA8B,EAAE,QAuGnDC,EAAgBD,EAAS,SAAU,EAKvCD,EAAO,QAAUE,ICdjB,IAAIC,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "factory", "Float32Matrix", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index b0bbaa9..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,361 +0,0 @@ - -{{alias}}( [options] ) - Returns a two-dimensional single-precision floating-point ndarray. - - Parameters - ---------- - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran-style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle indices which exceed array dimensions. If equal - to 'throw', an ndarray instance throws an error when an index exceeds - array dimensions. If equal to 'normalize', an ndarray instance - normalizes negative indices and throws an error when an index exceeds - array dimensions. If equal to 'wrap', an ndarray instance wraps around - indices exceeding array dimensions using modulo arithmetic. If equal to - 'clamp', an ndarray instance sets an index exceeding array dimensions - to either `0` (minimum index) or the maximum index. Default: 'throw'. - - options.submode: Array (optional) - Specifies how to handle subscripts which exceed array dimensions. If a - mode for a corresponding dimension is equal to 'throw', an ndarray - instance throws an error when a subscript exceeds array dimensions. If - equal to 'normalize', an ndarray instance normalizes negative - subscripts and throws an error when a subscript exceeds array - dimensions. If equal to 'wrap', an ndarray instance wraps around - subscripts exceeding array dimensions using modulo arithmetic. If equal - to 'clamp', an ndarray instance sets a subscript exceeding array - dimensions to either `0` (minimum index) or the maximum index. If the - number of modes is less than the number of dimensions, an ndarray - instance recycles modes using modulo arithmetic. - - Default: [ options.mode ]. - - options.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A two-dimensional ndarray. - - Examples - -------- - > var arr = {{alias}}() - - - -{{alias}}( shape[, options] ) - Returns a two-dimensional single-precision floating-point ndarray having a - specified shape. - - Parameters - ---------- - shape: ArrayLikeObject - Array shape. Must contain exactly two elements. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran-style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle indices which exceed array dimensions. If equal - to 'throw', an ndarray instance throws an error when an index exceeds - array dimensions. If equal to 'normalize', an ndarray instance - normalizes negative indices and throws an error when an index exceeds - array dimensions. If equal to 'wrap', an ndarray instance wraps around - indices exceeding array dimensions using modulo arithmetic. If equal to - 'clamp', an ndarray instance sets an index exceeding array dimensions - to either `0` (minimum index) or the maximum index. Default: 'throw'. - - options.submode: Array (optional) - Specifies how to handle subscripts which exceed array dimensions. If a - mode for a corresponding dimension is equal to 'throw', an ndarray - instance throws an error when a subscript exceeds array dimensions. If - equal to 'normalize', an ndarray instance normalizes negative - subscripts and throws an error when a subscript exceeds array - dimensions. If equal to 'wrap', an ndarray instance wraps around - subscripts exceeding array dimensions using modulo arithmetic. If equal - to 'clamp', an ndarray instance sets a subscript exceeding array - dimensions to either `0` (minimum index) or the maximum index. If the - number of modes is less than the number of dimensions, an ndarray - instance recycles modes using modulo arithmetic. - - Default: [ options.mode ]. - - options.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A two-dimensional ndarray. - - Examples - -------- - > var arr = {{alias}}( [ 2, 2 ] ) - - - -{{alias}}( M, N[, options] ) - Returns a two-dimensional single-precision floating-point ndarray having a - specified shape. - - Parameters - ---------- - M: integer - Number of rows. - - N: integer - Number of columns. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran-style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle indices which exceed array dimensions. If equal - to 'throw', an ndarray instance throws an error when an index exceeds - array dimensions. If equal to 'normalize', an ndarray instance - normalizes negative indices and throws an error when an index exceeds - array dimensions. If equal to 'wrap', an ndarray instance wraps around - indices exceeding array dimensions using modulo arithmetic. If equal to - 'clamp', an ndarray instance sets an index exceeding array dimensions - to either `0` (minimum index) or the maximum index. Default: 'throw'. - - options.submode: Array (optional) - Specifies how to handle subscripts which exceed array dimensions. If a - mode for a corresponding dimension is equal to 'throw', an ndarray - instance throws an error when a subscript exceeds array dimensions. If - equal to 'normalize', an ndarray instance normalizes negative - subscripts and throws an error when a subscript exceeds array - dimensions. If equal to 'wrap', an ndarray instance wraps around - subscripts exceeding array dimensions using modulo arithmetic. If equal - to 'clamp', an ndarray instance sets a subscript exceeding array - dimensions to either `0` (minimum index) or the maximum index. If the - number of modes is less than the number of dimensions, an ndarray - instance recycles modes using modulo arithmetic. - - Default: [ options.mode ]. - - options.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A two-dimensional ndarray. - - Examples - -------- - > var arr = {{alias}}( 2, 2 ) - - - -{{alias}}( obj[, options] ) - Creates a two-dimensional single-precision floating-point ndarray from an - array-like object or iterable. - - Parameters - ---------- - obj: Object - Array-like object or iterable from which to generate an ndarray. If an - array-like object, the value must be a nested array (i.e., an array-like - object of array-like objects), where each nested array must have the - same number of elements. If an iterable, the iterable must return array- - like objects, each of which must have the same number of elements. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran-style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle indices which exceed array dimensions. If equal - to 'throw', an ndarray instance throws an error when an index exceeds - array dimensions. If equal to 'normalize', an ndarray instance - normalizes negative indices and throws an error when an index exceeds - array dimensions. If equal to 'wrap', an ndarray instance wraps around - indices exceeding array dimensions using modulo arithmetic. If equal to - 'clamp', an ndarray instance sets an index exceeding array dimensions - to either `0` (minimum index) or the maximum index. Default: 'throw'. - - options.submode: Array (optional) - Specifies how to handle subscripts which exceed array dimensions. If a - mode for a corresponding dimension is equal to 'throw', an ndarray - instance throws an error when a subscript exceeds array dimensions. If - equal to 'normalize', an ndarray instance normalizes negative - subscripts and throws an error when a subscript exceeds array - dimensions. If equal to 'wrap', an ndarray instance wraps around - subscripts exceeding array dimensions using modulo arithmetic. If equal - to 'clamp', an ndarray instance sets a subscript exceeding array - dimensions to either `0` (minimum index) or the maximum index. If the - number of modes is less than the number of dimensions, an ndarray - instance recycles modes using modulo arithmetic. - - Default: [ options.mode ]. - - options.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A two-dimensional ndarray. - - Examples - -------- - > var v = [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]; - > var arr = {{alias}}( v ) - - - -{{alias}}( buffer[, byteOffset[, shape]][, options] ) - Returns a two-dimensional single-precision floating-point ndarray view of an - ArrayBuffer. - - Parameters - ---------- - buffer: ArrayBuffer - Underlying ArrayBuffer. - - byteOffset: integer (optional) - Integer byte offset specifying the location of the first indexed - element. Default: 0. - - shape: ArrayLikeObject (optional) - Array shape. Must contain exactly two elements. If not provided, the - view spans from the byteOffset to the end of the underlying ArrayBuffer - and the first dimension of the returned ndarray has a size of one. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran-style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle indices which exceed array dimensions. If equal - to 'throw', an ndarray instance throws an error when an index exceeds - array dimensions. If equal to 'normalize', an ndarray instance - normalizes negative indices and throws an error when an index exceeds - array dimensions. If equal to 'wrap', an ndarray instance wraps around - indices exceeding array dimensions using modulo arithmetic. If equal to - 'clamp', an ndarray instance sets an index exceeding array dimensions - to either `0` (minimum index) or the maximum index. Default: 'throw'. - - options.submode: Array (optional) - Specifies how to handle subscripts which exceed array dimensions. If a - mode for a corresponding dimension is equal to 'throw', an ndarray - instance throws an error when a subscript exceeds array dimensions. If - equal to 'normalize', an ndarray instance normalizes negative - subscripts and throws an error when a subscript exceeds array - dimensions. If equal to 'wrap', an ndarray instance wraps around - subscripts exceeding array dimensions using modulo arithmetic. If equal - to 'clamp', an ndarray instance sets a subscript exceeding array - dimensions to either `0` (minimum index) or the maximum index. If the - number of modes is less than the number of dimensions, an ndarray - instance recycles modes using modulo arithmetic. - - Default: [ options.mode ]. - - options.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A two-dimensional ndarray. - - Examples - -------- - > var buf = new {{alias:@stdlib/array/buffer}}( 32 ); - > var arr = {{alias}}( buf, 0, [ 8, 1 ] ) - - - -{{alias}}( buffer[, byteOffset[, M, N]][, options] ) - Returns a two-dimensional single-precision floating-point ndarray view of an - ArrayBuffer. - - If `M` and `N` are not provided, the returned ndarray view spans from the - byteOffset to the end of the underlying ArrayBuffer. - - Parameters - ---------- - buffer: ArrayBuffer - Underlying ArrayBuffer. - - byteOffset: integer (optional) - Integer byte offset specifying the location of the first indexed - element. Default: 0. - - M: integer (optional) - Number of rows. - - N: integer (optional) - Number of columns. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran-style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle indices which exceed array dimensions. If equal - to 'throw', an ndarray instance throws an error when an index exceeds - array dimensions. If equal to 'normalize', an ndarray instance - normalizes negative indices and throws an error when an index exceeds - array dimensions. If equal to 'wrap', an ndarray instance wraps around - indices exceeding array dimensions using modulo arithmetic. If equal to - 'clamp', an ndarray instance sets an index exceeding array dimensions - to either `0` (minimum index) or the maximum index. Default: 'throw'. - - options.submode: Array (optional) - Specifies how to handle subscripts which exceed array dimensions. If a - mode for a corresponding dimension is equal to 'throw', an ndarray - instance throws an error when a subscript exceeds array dimensions. If - equal to 'normalize', an ndarray instance normalizes negative - subscripts and throws an error when a subscript exceeds array - dimensions. If equal to 'wrap', an ndarray instance wraps around - subscripts exceeding array dimensions using modulo arithmetic. If equal - to 'clamp', an ndarray instance sets a subscript exceeding array - dimensions to either `0` (minimum index) or the maximum index. If the - number of modes is less than the number of dimensions, an ndarray - instance recycles modes using modulo arithmetic. - - Default: [ options.mode ]. - - options.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A two-dimensional ndarray. - - Examples - -------- - > var buf = new {{alias:@stdlib/array/buffer}}( 32 ); - > var arr = {{alias}}( buf, 0, 4, 1 ) - - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 0e6cc3d..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,100 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2026 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 ArrayBuffer = require( '@stdlib/array-buffer' ); -import Float32Matrix = require( './index' ); - - -// TESTS // - -// The function returns an ndarray... -{ - new Float32Matrix(); // $ExpectType float32ndarray - new Float32Matrix( {} ); // $ExpectType float32ndarray - - new Float32Matrix( 10, 10 ); // $ExpectType float32ndarray - new Float32Matrix( 10, 10, {} ); // $ExpectType float32ndarray - - new Float32Matrix( [ 10, 10 ] ); // $ExpectType float32ndarray - new Float32Matrix( [ 10, 10 ], {} ); // $ExpectType float32ndarray - - new Float32Matrix( [ [ 1, 2 ], [ 3, 4 ] ] ); // $ExpectType float32ndarray - new Float32Matrix( [ [ 1, 2 ], [ 3, 4 ] ], {} ); // $ExpectType float32ndarray - - new Float32Matrix( new ArrayBuffer( 10 ) ); // $ExpectType float32ndarray - new Float32Matrix( new ArrayBuffer( 10 ), {} ); // $ExpectType float32ndarray - - new Float32Matrix( new ArrayBuffer( 10 ), 8 ); // $ExpectType float32ndarray - new Float32Matrix( new ArrayBuffer( 10 ), 8, {} ); // $ExpectType float32ndarray - - new Float32Matrix( new ArrayBuffer( 10 ), 8, [ 1, 1 ] ); // $ExpectType float32ndarray - new Float32Matrix( new ArrayBuffer( 10 ), 8, [ 1, 1 ], {} ); // $ExpectType float32ndarray - - new Float32Matrix( new ArrayBuffer( 10 ), 8, 1, 1 ); // $ExpectType float32ndarray - new Float32Matrix( new ArrayBuffer( 10 ), 8, 1, 1, {} ); // $ExpectType float32ndarray - - const matrix = Float32Matrix; - matrix(); // $ExpectType float32ndarray - matrix( {} ); // $ExpectType float32ndarray - - matrix( 10, 10 ); // $ExpectType float32ndarray - matrix( 10, 10, {} ); // $ExpectType float32ndarray - - matrix( [ 10, 10 ] ); // $ExpectType float32ndarray - matrix( [ 10, 10 ], {} ); // $ExpectType float32ndarray - - matrix( [ [ 1, 2 ], [ 3, 4 ] ] ); // $ExpectType float32ndarray - matrix( [ [ 1, 2 ], [ 3, 4 ] ], {} ); // $ExpectType float32ndarray - - matrix( new ArrayBuffer( 10 ) ); // $ExpectType float32ndarray - matrix( new ArrayBuffer( 10 ), {} ); // $ExpectType float32ndarray - - matrix( new ArrayBuffer( 10 ), 8 ); // $ExpectType float32ndarray - matrix( new ArrayBuffer( 10 ), 8, {} ); // $ExpectType float32ndarray - - matrix( new ArrayBuffer( 10 ), 8, [ 1, 1 ] ); // $ExpectType float32ndarray - matrix( new ArrayBuffer( 10 ), 8, [ 1, 1 ], {} ); // $ExpectType float32ndarray - - matrix( new ArrayBuffer( 10 ), 8, 1, 1 ); // $ExpectType float32ndarray - matrix( new ArrayBuffer( 10 ), 8, 1, 1, {} ); // $ExpectType float32ndarray -} - -// The compiler throws an error if the function is provided a first argument which is not a number, array-like object, iterable, or options object... -{ - new Float32Matrix( true ); // $ExpectError - new Float32Matrix( false ); // $ExpectError - new Float32Matrix( null ); // $ExpectError - new Float32Matrix( ( x: number ): number => x ); // $ExpectError - - const matrix = Float32Matrix; - matrix( true ); // $ExpectError - matrix( false ); // $ExpectError - matrix( null ); // $ExpectError - matrix( ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const buf = new ArrayBuffer( 32 ); - new Float32Matrix( buf, 8, 2, 1, {}, {} ); // $ExpectError - new Float32Matrix( buf, 8, [ 2, 1 ], {}, {} ); // $ExpectError - - const matrix = Float32Matrix; - matrix( buf, 8, 2, 1, {}, {} ); // $ExpectError - matrix( buf, 8, [ 2, 1 ], {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index ca82258..0000000 --- a/examples/index.js +++ /dev/null @@ -1,51 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2026 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); -var sum = require( '@stdlib/blas-ext-sum' ); -var map = require( '@stdlib/ndarray-map' ); -var ndarray2array = require( '@stdlib/ndarray-to-array' ); -var Float32Matrix = require( './../lib' ); - -// Create a matrix containing random values: -var x = new Float32Matrix([ - discreteUniform( 10, 0, 100 ), - discreteUniform( 10, 0, 20 ) -]); - -// Compute the sum along the columns: -var v = sum( x, { - 'dims': [ -1 ] -}); -console.log( ndarray2array( v ) ); - -// Define a function which applies a threshold to individual values: -function threshold( v ) { - return ( v > 10 ) ? v : 0; -} - -// Apply threshold: -var y = map( x, threshold ); - -// Recompute the sum along the columns: -v = sum( y, { - 'dims': [ -1 ] -}); -console.log( ndarray2array( v ) ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 99% rename from docs/types/index.d.ts rename to index.d.ts index 7a51c73..485d4c8 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -20,7 +20,7 @@ /* eslint-disable @typescript-eslint/unified-signatures */ -/// +/// import { Order, Mode, float32ndarray, Shape2D } from '@stdlib/types/ndarray'; import { Collection, AccessorArrayLike, ArrayLike } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..d687205 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import{factory as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-matrix-ctor@esm/index.mjs";var r=t("float32");export{r as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..1fc582f --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2026 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* 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 as factory } from '@stdlib/ndarray-matrix-ctor';\n\n\n// MAIN //\n\n/**\n* Returns a single-precision floating-point matrix (i.e., a two-dimensional ndarray).\n*\n* @name Float32Matrix\n* @type {Function}\n* @param {(NonNegativeInteger|NonNegativeIntegerArray|ArrayLikeObject|ArrayBuffer|Iterable)} [arg0] - shape, number of rows, array-like object, ArrayBuffer, or iterable\n* @param {NonNegativeInteger} [arg1] - number of columns or byte offset\n* @param {(NonNegativeInteger|NonNegativeIntegerArray)} [arg2] - shape or number of rows\n* @param {NonNegativeInteger} [arg3] - number of columns\n* @param {Options} [options] - function options\n* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only matrix\n* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed matrix dimensions\n* @param {StringArray} [options.submode=[options.mode]] - specifies how to handle subscripts which exceed array dimensions on a per dimension basis\n* @param {string} [options.order='row-major'] - memory layout (either row-major or column-major)\n* @throws {TypeError} first argument must be either a shape, integer, array-like object, ArrayBuffer, iterable, or options object\n* @throws {TypeError} must provide valid options\n* @returns {ndarray} two-dimensional ndarray\n*\n* @example\n* import getShape from '@stdlib/ndarray-shape';\n*\n* var v = new Float32Matrix();\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 0, 0 ]\n*\n* @example\n* import getShape from '@stdlib/ndarray-shape';\n*\n* var v = new Float32Matrix( [ 2, 2 ] );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 2 ]\n*\n* @example\n* import getShape from '@stdlib/ndarray-shape';\n*\n* var v = new Float32Matrix( 2, 2 );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 2 ]\n*\n* @example\n* import getShape from '@stdlib/ndarray-shape';\n*\n* var v = new Float32Matrix( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 2 ]\n*\n* @example\n* import ArrayBuffer from '@stdlib/array-buffer';\n* import getShape from '@stdlib/ndarray-shape';\n*\n* var buf = new ArrayBuffer( 32 );\n* var v = new Float32Matrix( buf );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 1, 8 ]\n*\n* @example\n* import ArrayBuffer from '@stdlib/array-buffer';\n* import getShape from '@stdlib/ndarray-shape';\n*\n* var buf = new ArrayBuffer( 32 );\n* var v = new Float32Matrix( buf, 16 );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 1, 4 ]\n*\n* @example\n* import ArrayBuffer from '@stdlib/array-buffer';\n* import getShape from '@stdlib/ndarray-shape';\n*\n* var buf = new ArrayBuffer( 64 );\n* var v = new Float32Matrix( buf, 16, [ 2, 1 ] );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 1 ]\n*\n* @example\n* import ArrayBuffer from '@stdlib/array-buffer';\n* import getShape from '@stdlib/ndarray-shape';\n*\n* var buf = new ArrayBuffer( 64 );\n* var v = new Float32Matrix( buf, 16, 2, 1 );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 1 ]\n*/\nvar Float32Matrix = factory( 'float32' );\n\n\n// EXPORTS //\n\nexport default Float32Matrix;\n"],"names":["Float32Matrix","factory"],"mappings":";;kGA6HG,IAACA,EAAgBC,EAAS"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index b62f3e6..0000000 --- a/lib/index.js +++ /dev/null @@ -1,122 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2026 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 a single-precision floating-point matrix (i.e., a two-dimensional ndarray). -* -* @module @stdlib/ndarray-matrix-float32 -* -* @example -* var getShape = require( '@stdlib/ndarray-shape' ); -* var Float32Matrix = require( '@stdlib/ndarray-matrix-float32' ); -* -* var v = new Float32Matrix(); -* // returns -* -* var len = getShape( v ); -* // returns [ 0, 0 ] -* -* @example -* var getShape = require( '@stdlib/ndarray-shape' ); -* var Float32Matrix = require( '@stdlib/ndarray-matrix-float32' ); -* -* var v = new Float32Matrix( [ 2, 2 ] ); -* // returns -* -* var len = getShape( v ); -* // returns [ 2, 2 ] -* -* @example -* var getShape = require( '@stdlib/ndarray-shape' ); -* var Float32Matrix = require( '@stdlib/ndarray-matrix-float32' ); -* -* var v = new Float32Matrix( 2, 2 ); -* // returns -* -* var len = getShape( v ); -* // returns [ 2, 2 ] -* -* @example -* var getShape = require( '@stdlib/ndarray-shape' ); -* var Float32Matrix = require( '@stdlib/ndarray-matrix-float32' ); -* -* var v = new Float32Matrix( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ); -* // returns -* -* var len = getShape( v ); -* // returns [ 2, 2 ] -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var getShape = require( '@stdlib/ndarray-shape' ); -* var Float32Matrix = require( '@stdlib/ndarray-matrix-float32' ); -* -* var buf = new ArrayBuffer( 32 ); -* var v = new Float32Matrix( buf ); -* // returns -* -* var len = getShape( v ); -* // returns [ 1, 8 ] -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var getShape = require( '@stdlib/ndarray-shape' ); -* var Float32Matrix = require( '@stdlib/ndarray-matrix-float32' ); -* -* var buf = new ArrayBuffer( 32 ); -* var v = new Float32Matrix( buf, 16 ); -* // returns -* -* var len = getShape( v ); -* // returns [ 1, 4 ] -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var getShape = require( '@stdlib/ndarray-shape' ); -* var Float32Matrix = require( '@stdlib/ndarray-matrix-float32' ); -* -* var buf = new ArrayBuffer( 64 ); -* var v = new Float32Matrix( buf, 16, [ 2, 1 ] ); -* // returns -* -* var len = getShape( v ); -* // returns [ 2, 1 ] -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var getShape = require( '@stdlib/ndarray-shape' ); -* var Float32Matrix = require( '@stdlib/ndarray-matrix-float32' ); -* -* var buf = new ArrayBuffer( 64 ); -* var v = new Float32Matrix( buf, 16, 2, 1 ); -* // returns -* -* var len = getShape( v ); -* // returns [ 2, 1 ] -*/ - -// MODULES // - -var main = require( './main.js' ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index a1e2693..0000000 --- a/lib/main.js +++ /dev/null @@ -1,131 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2026 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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( '@stdlib/ndarray-matrix-ctor' ).factory; - - -// MAIN // - -/** -* Returns a single-precision floating-point matrix (i.e., a two-dimensional ndarray). -* -* @name Float32Matrix -* @type {Function} -* @param {(NonNegativeInteger|NonNegativeIntegerArray|ArrayLikeObject|ArrayBuffer|Iterable)} [arg0] - shape, number of rows, array-like object, ArrayBuffer, or iterable -* @param {NonNegativeInteger} [arg1] - number of columns or byte offset -* @param {(NonNegativeInteger|NonNegativeIntegerArray)} [arg2] - shape or number of rows -* @param {NonNegativeInteger} [arg3] - number of columns -* @param {Options} [options] - function options -* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only matrix -* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed matrix dimensions -* @param {StringArray} [options.submode=[options.mode]] - specifies how to handle subscripts which exceed array dimensions on a per dimension basis -* @param {string} [options.order='row-major'] - memory layout (either row-major or column-major) -* @throws {TypeError} first argument must be either a shape, integer, array-like object, ArrayBuffer, iterable, or options object -* @throws {TypeError} must provide valid options -* @returns {ndarray} two-dimensional ndarray -* -* @example -* var getShape = require( '@stdlib/ndarray-shape' ); -* -* var v = new Float32Matrix(); -* // returns -* -* var len = getShape( v ); -* // returns [ 0, 0 ] -* -* @example -* var getShape = require( '@stdlib/ndarray-shape' ); -* -* var v = new Float32Matrix( [ 2, 2 ] ); -* // returns -* -* var len = getShape( v ); -* // returns [ 2, 2 ] -* -* @example -* var getShape = require( '@stdlib/ndarray-shape' ); -* -* var v = new Float32Matrix( 2, 2 ); -* // returns -* -* var len = getShape( v ); -* // returns [ 2, 2 ] -* -* @example -* var getShape = require( '@stdlib/ndarray-shape' ); -* -* var v = new Float32Matrix( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ); -* // returns -* -* var len = getShape( v ); -* // returns [ 2, 2 ] -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var getShape = require( '@stdlib/ndarray-shape' ); -* -* var buf = new ArrayBuffer( 32 ); -* var v = new Float32Matrix( buf ); -* // returns -* -* var len = getShape( v ); -* // returns [ 1, 8 ] -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var getShape = require( '@stdlib/ndarray-shape' ); -* -* var buf = new ArrayBuffer( 32 ); -* var v = new Float32Matrix( buf, 16 ); -* // returns -* -* var len = getShape( v ); -* // returns [ 1, 4 ] -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var getShape = require( '@stdlib/ndarray-shape' ); -* -* var buf = new ArrayBuffer( 64 ); -* var v = new Float32Matrix( buf, 16, [ 2, 1 ] ); -* // returns -* -* var len = getShape( v ); -* // returns [ 2, 1 ] -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var getShape = require( '@stdlib/ndarray-shape' ); -* -* var buf = new ArrayBuffer( 64 ); -* var v = new Float32Matrix( buf, 16, 2, 1 ); -* // returns -* -* var len = getShape( v ); -* // returns [ 2, 1 ] -*/ -var Float32Matrix = factory( 'float32' ); - - -// EXPORTS // - -module.exports = Float32Matrix; diff --git a/package.json b/package.json index d6f3604..fe36b21 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.0.0", "description": "Create a single-precision floating-point matrix (i.e., a two-dimensional ndarray).", "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,47 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/ndarray-matrix-ctor": "github:stdlib-js/ndarray-matrix-ctor#main", - "@stdlib/types": "^0.5.1" - }, - "devDependencies": { - "@stdlib/array-buffer": "^0.2.3", - "@stdlib/array-float32": "^0.2.3", - "@stdlib/assert-is-ndarray-like": "^0.2.3", - "@stdlib/assert-is-ndarray-like-with-data-type": "^0.1.1", - "@stdlib/assert-is-same-float32array": "^0.2.3", - "@stdlib/blas-ext-sum": "^0.1.1", - "@stdlib/math-base-special-floor": "^0.2.4", - "@stdlib/math-base-special-pow": "^0.3.1", - "@stdlib/ndarray-base-assert-is-read-only": "^0.2.3", - "@stdlib/ndarray-data-buffer": "^0.2.3", - "@stdlib/ndarray-map": "^0.1.1", - "@stdlib/ndarray-order": "^0.2.3", - "@stdlib/ndarray-shape": "^0.2.3", - "@stdlib/ndarray-to-array": "^0.2.2", - "@stdlib/random-array-discrete-uniform": "^0.2.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.3", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.3" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..0807e84 --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 65fdf78..0000000 --- a/test/test.js +++ /dev/null @@ -1,1394 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2026 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable no-new */ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var isndarrayLikeWithDataType = require( '@stdlib/assert-is-ndarray-like-with-data-type' ); -var isSameFloat32Array = require( '@stdlib/assert-is-same-float32array' ); -var isReadOnly = require( '@stdlib/ndarray-base-assert-is-read-only' ); -var ArrayBuffer = require( '@stdlib/array-buffer' ); -var Float32Array = require( '@stdlib/array-float32' ); -var getData = require( '@stdlib/ndarray-data-buffer' ); -var getShape = require( '@stdlib/ndarray-shape' ); -var getOrder = require( '@stdlib/ndarray-order' ); -var Float32Matrix = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof Float32Matrix, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if provided an invalid first argument', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1 ], - [ 1, 2, 3 ], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1 ], - [ 1, 2, 3 ], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( value, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (second argument)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( value, 0 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (second argument, options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( value, 0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (byteoffset, shape)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( value, 0, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (byteoffset, shape, options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( value, 0, [ 0, 0 ], {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (byteoffset, M, N)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( value, 0, 0, 0 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (byteoffset, M, N, options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( value, 0, 0, 0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid byte offset argument', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( new ArrayBuffer( 8 ), value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid byte offset argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( new ArrayBuffer( 8 ), value, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid byte offset argument (shape)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( new ArrayBuffer( 8 ), value, [ 1, 1 ] ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid byte offset argument (shape, options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( new ArrayBuffer( 8 ), value, [ 1, 1 ], {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid byte offset argument (M, N)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( new ArrayBuffer( 8 ), value, 1, 1 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid byte offset argument (M, N, options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( new ArrayBuffer( 8 ), value, 1, 1, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1 ], - [ 1, 1, 1 ], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( new ArrayBuffer( 8 ), 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1 ], - [ 1, 1, 1 ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( new ArrayBuffer( 8 ), 0, value, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid `M` argument', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1 ], - [ 1, 1, 1 ], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( new ArrayBuffer( 8 ), 0, value, 1 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid `M` argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1 ], - [ 1, 1, 1 ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( new ArrayBuffer( 8 ), 0, value, 1, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid `N` argument', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1 ], - [ 1, 1, 1 ], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( new ArrayBuffer( 8 ), 0, 1, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid `N` argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1 ], - [ 1, 1, 1 ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( new ArrayBuffer( 8 ), 0, 1, value, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (shape)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( [ 3, 3 ], value ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (M, N)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( 3, 3, value ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (array)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ], value ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (arraybuffer)', function test( t ) { - var values; - var i; - - values = [ - '5', - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( new ArrayBuffer( 8 ), value ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (arraybuffer, byteoffset)', function test( t ) { - var values; - var i; - - values = [ - '5', - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( new ArrayBuffer( 8 ), 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (arraybuffer, byteoffset, shape)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( new ArrayBuffer( 8 ), 0, [ 1, 1 ], value ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (arraybuffer, byteoffset, M, N)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( new ArrayBuffer( 8 ), 0, 1, 1, value ); - }; - } -}); - -tape( 'the function throws an error if provided an `order` option which is not a recognized order', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'ROW', - 'row', - 'col-major', - 'col', - 'major', - 'minor', - null - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix({ - 'order': value - }); - }; - } -}); - -tape( 'the function throws an error if provided a `mode` option which is not a recognized mode', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'THROW', - 5, - null, - true, - false, - [], - {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix({ - 'mode': value - }); - }; - } -}); - -tape( 'the function throws an error if provided a `mode` option which is not a recognized submode', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'THROW', - 5, - null, - true, - false, - [], - {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix({ - 'submode': [ value ] - }); - }; - } -}); - -tape( 'the function throws an error if provided a `readonly` option which is not a boolean', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - null, - void 0, - [], - {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix({ - 'readonly': value - }); - }; - } -}); - -tape( 'the function returns a two-dimensional ndarray', function test( t ) { - var arr; - - arr = new Float32Matrix(); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 0, 0 ], 'returns expected value' ); - - arr = new Float32Matrix( {} ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a two-dimensional ndarray (shape)', function test( t ) { - var arr; - - arr = new Float32Matrix( [ 3, 3 ] ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 3, 3 ], 'returns expected value' ); - - arr = new Float32Matrix( [ 3, 3 ], {} ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 3, 3 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a two-dimensional ndarray (M, N)', function test( t ) { - var arr; - - arr = new Float32Matrix( 3, 3 ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 3, 3 ], 'returns expected value' ); - - arr = new Float32Matrix( 3, 3, {} ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 3, 3 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a two-dimensional ndarray (array)', function test( t ) { - var arr; - var out; - - arr = [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]; - - out = new Float32Matrix( arr ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( out ), [ 2, 2 ], 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( [ 1.0, 2.0, 3.0, 4.0 ] ) ), true, 'returns expected value' ); - - out = new Float32Matrix( arr, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( out ), [ 2, 2 ], 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( [ 1.0, 2.0, 3.0, 4.0 ] ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a two-dimensional ndarray (arraybuffer)', function test( t ) { - var buf; - var out; - - buf = new ArrayBuffer( 16 ); - - out = new Float32Matrix( buf ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( out ), [ 1, 4 ], 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf ) ), true, 'returns expected value' ); - - out = new Float32Matrix( buf, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( out ), [ 1, 4 ], 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a two-dimensional ndarray (arraybuffer, byteoffset)', function test( t ) { - var buf; - var out; - - buf = new ArrayBuffer( 64 ); - - out = new Float32Matrix( buf, 8 ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( out ), [ 1, 14 ], 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf, 8 ) ), true, 'returns expected value' ); - - out = new Float32Matrix( buf, 8, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( out ), [ 1, 14 ], 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf, 8 ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a two-dimensional ndarray (arraybuffer, byteoffset, shape)', function test( t ) { - var buf; - var out; - - buf = new ArrayBuffer( 64 ); - - out = new Float32Matrix( buf, 8, [ 2, 1 ] ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( out ), [ 2, 1 ], 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf, 8, 2 ) ), true, 'returns expected value' ); - - out = new Float32Matrix( buf, 8, [ 2, 1 ], {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( out ), [ 2, 1 ], 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf, 8, 2 ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a two-dimensional ndarray (arraybuffer, byteoffset, M, N)', function test( t ) { - var buf; - var out; - - buf = new ArrayBuffer( 64 ); - - out = new Float32Matrix( buf, 8, 2, 1 ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( out ), [ 2, 1 ], 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf, 8, 2 ) ), true, 'returns expected value' ); - - out = new Float32Matrix( buf, 8, 2, 1, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( out ), [ 2, 1 ], 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf, 8, 2 ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout', function test( t ) { - var arr; - - arr = new Float32Matrix({ - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 0, 0 ], 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Float32Matrix({ - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 0, 0 ], 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (shape)', function test( t ) { - var arr; - - arr = new Float32Matrix( [ 3, 3 ], { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 3, 3 ], 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Float32Matrix( [ 3, 3 ], { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 3, 3 ], 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (array)', function test( t ) { - var arr; - - arr = new Float32Matrix( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ], { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 2, 2 ], 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Float32Matrix( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ], { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 2, 2 ], 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (arraybuffer)', function test( t ) { - var arr; - - arr = new Float32Matrix( new ArrayBuffer( 64 ), { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 1, 16 ], 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Float32Matrix( new ArrayBuffer( 64 ), { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 1, 16 ], 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (arraybuffer, byteoffset)', function test( t ) { - var arr; - - arr = new Float32Matrix( new ArrayBuffer( 64 ), 8, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 1, 14 ], 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Float32Matrix( new ArrayBuffer( 64 ), 8, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 1, 14 ], 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (arraybuffer, byteoffset, shape)', function test( t ) { - var arr; - - arr = new Float32Matrix( new ArrayBuffer( 64 ), 8, [ 2, 1 ], { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 2, 1 ], 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Float32Matrix( new ArrayBuffer( 64 ), 8, [ 2, 1 ], { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 2, 1 ], 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (arraybuffer, byteoffset, M, N)', function test( t ) { - var arr; - - arr = new Float32Matrix( new ArrayBuffer( 64 ), 8, 2, 1, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 2, 1 ], 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Float32Matrix( new ArrayBuffer( 64 ), 8, 2, 1, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 2, 1 ], 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning read-only ndarrays', function test( t ) { - var arr; - - arr = new Float32Matrix({ - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 0, 0 ], 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning read-only ndarrays (shape)', function test( t ) { - var arr; - - arr = new Float32Matrix( [ 3, 3 ], { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 3, 3 ], 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning read-only ndarrays (array)', function test( t ) { - var arr; - - arr = new Float32Matrix( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ], { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 2, 2 ], 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning read-only ndarrays (arraybuffer)', function test( t ) { - var arr; - - arr = new Float32Matrix( new ArrayBuffer( 64 ), { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 1, 16 ], 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning read-only ndarrays (arraybuffer, byteoffset)', function test( t ) { - var arr; - - arr = new Float32Matrix( new ArrayBuffer( 64 ), 8, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 1, 14 ], 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning read-only ndarrays (arraybuffer, byteoffset, shape)', function test( t ) { - var arr; - - arr = new Float32Matrix( new ArrayBuffer( 64 ), 8, [ 2, 1 ], { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 2, 1 ], 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning read-only ndarrays (arraybuffer, byteoffset, M, N)', function test( t ) { - var arr; - - arr = new Float32Matrix( new ArrayBuffer( 64 ), 8, 2, 1, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 2, 1 ], 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning writable ndarrays', function test( t ) { - var arr; - - arr = new Float32Matrix({ - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 0, 0 ], 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning writable ndarrays (shape)', function test( t ) { - var arr; - - arr = new Float32Matrix( [ 3, 3 ], { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 3, 3 ], 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning writable ndarrays (array)', function test( t ) { - var arr; - - arr = new Float32Matrix( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ], { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 2, 2 ], 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning writable ndarrays (arraybuffer)', function test( t ) { - var arr; - - arr = new Float32Matrix( new ArrayBuffer( 64 ), { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 1, 16 ], 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning writable ndarrays (arraybuffer, byteoffset)', function test( t ) { - var arr; - - arr = new Float32Matrix( new ArrayBuffer( 64 ), 8, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 1, 14 ], 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning writable ndarrays (arraybuffer, byteoffset, shape)', function test( t ) { - var arr; - - arr = new Float32Matrix( new ArrayBuffer( 64 ), 8, [ 2, 1 ], { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 2, 1 ], 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning writable ndarrays (arraybuffer, byteoffset, M, N)', function test( t ) { - var arr; - - arr = new Float32Matrix( new ArrayBuffer( 64 ), 8, 2, 1, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 2, 1 ], 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); From 2c180a696cab44ca0d18fa88e452f8ebbcf62043 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 26 Jun 2026 18:37:04 +0000 Subject: [PATCH 03/11] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 0177c84..d6f3604 100644 --- a/package.json +++ b/package.json @@ -56,7 +56,7 @@ "@stdlib/ndarray-shape": "^0.2.3", "@stdlib/ndarray-to-array": "^0.2.2", "@stdlib/random-array-discrete-uniform": "^0.2.2", - "@stdlib/string-format": "^0.2.3", + "@stdlib/error-tools-fmtprodmsg": "^0.2.3", "tape": "git+https://github.com/kgryte/tape.git#fix/globby", "istanbul": "^0.4.1", "tap-min": "git+https://github.com/Planeshifter/tap-min.git", From 882b773d8fce7466a524012b0da196f524d2fb98 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 26 Jun 2026 18:39:29 +0000 Subject: [PATCH 04/11] Remove files --- index.d.ts | 532 ------ index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5379 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 485d4c8..0000000 --- a/index.d.ts +++ /dev/null @@ -1,532 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2026 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 - -/* eslint-disable @typescript-eslint/unified-signatures */ - -/// - -import { Order, Mode, float32ndarray, Shape2D } from '@stdlib/types/ndarray'; -import { Collection, AccessorArrayLike, ArrayLike } from '@stdlib/types/array'; -import ArrayBuffer = require( '@stdlib/array-buffer' ); - -/** -* Interface describing function options. -*/ -interface Options { - /** - * Array order (either 'row-major' (C-style) or 'column-major' (Fortran-style)). - */ - order?: Order; - - /** - * Specifies how to handle a linear index which exceeds array dimensions (default: 'throw'). - */ - mode?: Mode; - - /** - * Specifies how to handle subscripts which exceed array dimensions on a per dimension basis (default: ['throw']). - */ - submode?: ArrayLike; - - /** - * Boolean indicating whether an array should be read-only (default: false). - */ - readonly?: boolean; -} - -/** -* Interface defining a typed matrix constructor which is both "newable" and "callable". -*/ -interface Float32Matrix { - /** - * Creates a single-precision floating-point matrix (i.e., a two-dimensional ndarray). - * - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only matrix - * @param options.mode - specifies how to handle indices which exceed matrix dimensions - * @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis - * @param options.order - memory layout (either row-major or column-major) - * @returns two-dimensional ndarray - * - * @example - * var getShape = require( '@stdlib/ndarray-shape' ); - * - * var arr = new Float32Matrix(); - * // returns - * - * var sh = getShape( arr ); - * // returns [ 0, 0 ] - */ - new ( options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point matrix (i.e., a two-dimensional ndarray). - * - * @param shape - matrix shape - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only matrix - * @param options.mode - specifies how to handle indices which exceed matrix dimensions - * @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis - * @param options.order - memory layout (either row-major or column-major) - * @returns two-dimensional ndarray - * - * @example - * var getShape = require( '@stdlib/ndarray-shape' ); - * - * var arr = new Float32Matrix( [ 2, 2 ] ); - * // returns - * - * var sh = getShape( arr ); - * // returns [ 2, 2 ] - */ - new ( shape: Shape2D, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point matrix (i.e., a two-dimensional ndarray). - * - * @param M - number of rows - * @param N - number of columns - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only matrix - * @param options.mode - specifies how to handle indices which exceed matrix dimensions - * @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis - * @param options.order - memory layout (either row-major or column-major) - * @returns two-dimensional ndarray - * - * @example - * var getShape = require( '@stdlib/ndarray-shape' ); - * - * var arr = new Float32Matrix( 2, 2 ); - * // returns - * - * var sh = getShape( arr ); - * // returns [ 2, 2 ] - */ - new ( M: number, N: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point matrix (i.e., a two-dimensional ndarray). - * - * @param obj - array-like object or iterable from which to generate a matrix - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only matrix - * @param options.mode - specifies how to handle indices which exceed matrix dimensions - * @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis - * @param options.order - memory layout (either row-major or column-major) - * @returns two-dimensional ndarray - * - * @example - * var getShape = require( '@stdlib/ndarray-shape' ); - * - * var arr = new Float32Matrix( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ); - * // returns - * - * var sh = getShape( arr ); - * // returns [ 2, 2 ] - */ - new ( obj: ArrayLike | AccessorArrayLike> | Iterable | AccessorArrayLike>, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point matrix (i.e., a two-dimensional ndarray). - * - * ## Notes - * - * - The returned ndarray view spans the entirety of the underlying ArrayBuffer and the leading dimension of the returned ndarray always has a size of one. - * - * @param buffer - underlying ArrayBuffer - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only matrix - * @param options.mode - specifies how to handle indices which exceed matrix dimensions - * @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis - * @param options.order - memory layout (either row-major or column-major) - * @returns two-dimensional ndarray - * - * @example - * var getShape = require( '@stdlib/ndarray-shape' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Matrix( buf ); - * // returns - * - * var sh = getShape( arr ); - * // returns [ 1, 8 ] - */ - new ( buffer: ArrayBuffer, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point matrix (i.e., a two-dimensional ndarray). - * - * ## Notes - * - * - The returned ndarray view spans from the byteOffset to the end of the underlying ArrayBuffer and the leading dimension of the returned ndarray always has a size of one. - * - * @param buffer - underlying ArrayBuffer - * @param byteOffset - integer byte offset specifying the location of the first matrix element - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only matrix - * @param options.mode - specifies how to handle indices which exceed matrix dimensions - * @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis - * @param options.order - memory layout (either row-major or column-major) - * @returns two-dimensional ndarray - * - * @example - * var getShape = require( '@stdlib/ndarray-shape' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Matrix( buf, 8 ); - * // returns - * - * var sh = getShape( arr ); - * // returns [ 1, 6 ] - */ - new ( buffer: ArrayBuffer, byteOffset: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point matrix (i.e., a two-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param byteOffset - integer byte offset specifying the location of the first matrix element - * @param shape - matrix shape - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only matrix - * @param options.mode - specifies how to handle indices which exceed matrix dimensions - * @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis - * @param options.order - memory layout (either row-major or column-major) - * @returns two-dimensional ndarray - * - * @example - * var getShape = require( '@stdlib/ndarray-shape' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Matrix( buf, 8, [ 2, 1 ] ); - * // returns - * - * var sh = getShape( arr ); - * // returns [ 2, 1 ] - */ - new ( buffer: ArrayBuffer, byteOffset: number, shape: Shape2D, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point matrix (i.e., a two-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param byteOffset - integer byte offset specifying the location of the first matrix element - * @param M - number of rows - * @param N - number of columns - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only matrix - * @param options.mode - specifies how to handle indices which exceed matrix dimensions - * @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis - * @param options.order - memory layout (either row-major or column-major) - * @returns two-dimensional ndarray - * - * @example - * var getShape = require( '@stdlib/ndarray-shape' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Matrix( buf, 8, 2, 1 ); - * // returns - * - * var sh = getShape( arr ); - * // returns [ 2, 1 ] - */ - new ( buffer: ArrayBuffer, byteOffset: number, M: number, N: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point matrix (i.e., a two-dimensional ndarray). - * - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only matrix - * @param options.mode - specifies how to handle indices which exceed matrix dimensions - * @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis - * @param options.order - memory layout (either row-major or column-major) - * @returns two-dimensional ndarray - * - * @example - * var getShape = require( '@stdlib/ndarray-shape' ); - * - * var arr = new Float32Matrix(); - * // returns - * - * var sh = getShape( arr ); - * // returns [ 0, 0 ] - */ - ( options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point matrix (i.e., a two-dimensional ndarray). - * - * @param shape - matrix shape - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only matrix - * @param options.mode - specifies how to handle indices which exceed matrix dimensions - * @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis - * @param options.order - memory layout (either row-major or column-major) - * @returns two-dimensional ndarray - * - * @example - * var getShape = require( '@stdlib/ndarray-shape' ); - * - * var arr = new Float32Matrix( [ 2, 2 ] ); - * // returns - * - * var sh = getShape( arr ); - * // returns [ 2, 2 ] - */ - ( shape: Shape2D, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point matrix (i.e., a two-dimensional ndarray). - * - * @param M - number of rows - * @param N - number of columns - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only matrix - * @param options.mode - specifies how to handle indices which exceed matrix dimensions - * @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis - * @param options.order - memory layout (either row-major or column-major) - * @returns two-dimensional ndarray - * - * @example - * var getShape = require( '@stdlib/ndarray-shape' ); - * - * var arr = new Float32Matrix( 2, 2 ); - * // returns - * - * var sh = getShape( arr ); - * // returns [ 2, 2 ] - */ - ( M: number, N: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point matrix (i.e., a two-dimensional ndarray). - * - * @param obj - array-like object or iterable from which to generate a matrix - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only matrix - * @param options.mode - specifies how to handle indices which exceed matrix dimensions - * @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis - * @param options.order - memory layout (either row-major or column-major) - * @returns two-dimensional ndarray - * - * @example - * var getShape = require( '@stdlib/ndarray-shape' ); - * - * var arr = new Float32Matrix( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ); - * // returns - * - * var sh = getShape( arr ); - * // returns [ 2, 2 ] - */ - ( obj: ArrayLike | AccessorArrayLike> | Iterable | AccessorArrayLike>, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point matrix (i.e., a two-dimensional ndarray). - * - * ## Notes - * - * - The returned ndarray view spans the entirety of the underlying ArrayBuffer and the leading dimension of the returned ndarray always has a size of one. - * - * @param buffer - underlying ArrayBuffer - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only matrix - * @param options.mode - specifies how to handle indices which exceed matrix dimensions - * @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis - * @param options.order - memory layout (either row-major or column-major) - * @returns two-dimensional ndarray - * - * @example - * var getShape = require( '@stdlib/ndarray-shape' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Matrix( buf ); - * // returns - * - * var sh = getShape( arr ); - * // returns [ 1, 8 ] - */ - ( buffer: ArrayBuffer, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point matrix (i.e., a two-dimensional ndarray). - * - * ## Notes - * - * - The returned ndarray view spans from the byteOffset to the end of the underlying ArrayBuffer and the leading dimension of the returned ndarray always has a size of one. - * - * @param buffer - underlying ArrayBuffer - * @param byteOffset - integer byte offset specifying the location of the first matrix element - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only matrix - * @param options.mode - specifies how to handle indices which exceed matrix dimensions - * @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis - * @param options.order - memory layout (either row-major or column-major) - * @returns two-dimensional ndarray - * - * @example - * var getShape = require( '@stdlib/ndarray-shape' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Matrix( buf, 8 ); - * // returns - * - * var sh = getShape( arr ); - * // returns [ 1, 6 ] - */ - ( buffer: ArrayBuffer, byteOffset: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point matrix (i.e., a two-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param byteOffset - integer byte offset specifying the location of the first matrix element - * @param shape - matrix shape - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only matrix - * @param options.mode - specifies how to handle indices which exceed matrix dimensions - * @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis - * @param options.order - memory layout (either row-major or column-major) - * @returns two-dimensional ndarray - * - * @example - * var getShape = require( '@stdlib/ndarray-shape' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Matrix( buf, 8, [ 2, 1 ] ); - * // returns - * - * var sh = getShape( arr ); - * // returns [ 2, 1 ] - */ - ( buffer: ArrayBuffer, byteOffset: number, shape: Shape2D, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point matrix (i.e., a two-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param byteOffset - integer byte offset specifying the location of the first matrix element - * @param M - number of rows - * @param N - number of columns - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only matrix - * @param options.mode - specifies how to handle indices which exceed matrix dimensions - * @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis - * @param options.order - memory layout (either row-major or column-major) - * @returns two-dimensional ndarray - * - * @example - * var getShape = require( '@stdlib/ndarray-shape' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Matrix( buf, 8, [ 2, 1 ] ); - * // returns - * - * var sh = getShape( arr ); - * // returns [ 2, 1 ] - */ - ( buffer: ArrayBuffer, byteOffset: number, M: number, N: number, options?: Options ): float32ndarray; -} - -/** -* Creates a single-precision floating-point matrix (i.e., a two-dimensional ndarray). -* -* @param arg0 - shape, number of rows, array-like object, ArrayBuffer, or iterable -* @param arg1 - number of columns or integer byte offset specifying the location of the first matrix element -* @param arg2 - matrix shape or number of rows -* @param arg3 - number of columns -* @param options - function options -* @param options.readonly - boolean indicating whether to return a read-only matrix -* @param options.mode - specifies how to handle indices which exceed matrix dimensions -* @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis -* @param options.order - memory layout (either row-major or column-major) -* @returns two-dimensional ndarray -* -* @example -* var getShape = require( '@stdlib/ndarray-shape' ); -* -* var arr = new Float32Matrix(); -* // returns -* -* var sh = getShape( arr ); -* // returns [ 0, 0 ] -* -* @example -* var getShape = require( '@stdlib/ndarray-shape' ); -* -* var arr = new Float32Matrix( [ 2, 2 ] ); -* // returns -* -* var sh = getShape( arr ); -* // returns [ 2, 2 ] -* -* @example -* var getShape = require( '@stdlib/ndarray-shape' ); -* -* var arr = new Float32Matrix( 2, 2 ); -* // returns -* -* var sh = getShape( arr ); -* // returns [ 2, 2 ] -* -* @example -* var getShape = require( '@stdlib/ndarray-shape' ); -* -* var arr = new Float32Matrix( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ); -* // returns -* -* var sh = getShape( arr ); -* // returns [ 2, 2 ] -* -* @example -* var getShape = require( '@stdlib/ndarray-shape' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 32 ); -* var arr = new Float32Matrix( buf, 8, [ 2, 1 ] ); -* // returns -* -* var sh = getShape( arr ); -* // returns [ 2, 1 ] -* -* @example -* var getShape = require( '@stdlib/ndarray-shape' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 32 ); -* var arr = new Float32Matrix( buf, 8, 2, 1 ); -* // returns -* -* var sh = getShape( arr ); -* // returns [ 2, 1 ] -*/ -declare var ctor: Float32Matrix; - - -// EXPORTS // - -export = ctor; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index d687205..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import{factory as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-matrix-ctor@esm/index.mjs";var r=t("float32");export{r as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 1fc582f..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2026 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* 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 as factory } from '@stdlib/ndarray-matrix-ctor';\n\n\n// MAIN //\n\n/**\n* Returns a single-precision floating-point matrix (i.e., a two-dimensional ndarray).\n*\n* @name Float32Matrix\n* @type {Function}\n* @param {(NonNegativeInteger|NonNegativeIntegerArray|ArrayLikeObject|ArrayBuffer|Iterable)} [arg0] - shape, number of rows, array-like object, ArrayBuffer, or iterable\n* @param {NonNegativeInteger} [arg1] - number of columns or byte offset\n* @param {(NonNegativeInteger|NonNegativeIntegerArray)} [arg2] - shape or number of rows\n* @param {NonNegativeInteger} [arg3] - number of columns\n* @param {Options} [options] - function options\n* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only matrix\n* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed matrix dimensions\n* @param {StringArray} [options.submode=[options.mode]] - specifies how to handle subscripts which exceed array dimensions on a per dimension basis\n* @param {string} [options.order='row-major'] - memory layout (either row-major or column-major)\n* @throws {TypeError} first argument must be either a shape, integer, array-like object, ArrayBuffer, iterable, or options object\n* @throws {TypeError} must provide valid options\n* @returns {ndarray} two-dimensional ndarray\n*\n* @example\n* import getShape from '@stdlib/ndarray-shape';\n*\n* var v = new Float32Matrix();\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 0, 0 ]\n*\n* @example\n* import getShape from '@stdlib/ndarray-shape';\n*\n* var v = new Float32Matrix( [ 2, 2 ] );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 2 ]\n*\n* @example\n* import getShape from '@stdlib/ndarray-shape';\n*\n* var v = new Float32Matrix( 2, 2 );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 2 ]\n*\n* @example\n* import getShape from '@stdlib/ndarray-shape';\n*\n* var v = new Float32Matrix( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 2 ]\n*\n* @example\n* import ArrayBuffer from '@stdlib/array-buffer';\n* import getShape from '@stdlib/ndarray-shape';\n*\n* var buf = new ArrayBuffer( 32 );\n* var v = new Float32Matrix( buf );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 1, 8 ]\n*\n* @example\n* import ArrayBuffer from '@stdlib/array-buffer';\n* import getShape from '@stdlib/ndarray-shape';\n*\n* var buf = new ArrayBuffer( 32 );\n* var v = new Float32Matrix( buf, 16 );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 1, 4 ]\n*\n* @example\n* import ArrayBuffer from '@stdlib/array-buffer';\n* import getShape from '@stdlib/ndarray-shape';\n*\n* var buf = new ArrayBuffer( 64 );\n* var v = new Float32Matrix( buf, 16, [ 2, 1 ] );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 1 ]\n*\n* @example\n* import ArrayBuffer from '@stdlib/array-buffer';\n* import getShape from '@stdlib/ndarray-shape';\n*\n* var buf = new ArrayBuffer( 64 );\n* var v = new Float32Matrix( buf, 16, 2, 1 );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 1 ]\n*/\nvar Float32Matrix = factory( 'float32' );\n\n\n// EXPORTS //\n\nexport default Float32Matrix;\n"],"names":["Float32Matrix","factory"],"mappings":";;kGA6HG,IAACA,EAAgBC,EAAS"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 0807e84..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 1097d0747f5ca3f71dd5fe9ab21e6df8ed1ab9ba Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 26 Jun 2026 18:40:02 +0000 Subject: [PATCH 05/11] Auto-generated commit --- .editorconfig | 189 - .eslintrc.js | 1 - .gitattributes | 68 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 821 --- .github/workflows/publish.yml | 261 - .github/workflows/test.yml | 101 - .github/workflows/test_bundles.yml | 213 - .github/workflows/test_coverage.yml | 142 - .github/workflows/test_install.yml | 94 - .github/workflows/test_published_package.yml | 115 - .gitignore | 204 - .npmignore | 229 - .npmrc | 44 - CHANGELOG.md | 51 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 63 +- SECURITY.md | 5 - benchmark/benchmark.js | 47 - benchmark/benchmark.size.js | 95 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 361 -- docs/types/test.ts | 100 - examples/index.js | 51 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 122 - lib/main.js | 131 - package.json | 68 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 1394 ----- 44 files changed, 4877 insertions(+), 5974 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .github/workflows/test_published_package.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/benchmark.size.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 (99%) create mode 100644 index.mjs create mode 100644 index.mjs.map 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.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 80f3fca..0000000 --- a/.editorconfig +++ /dev/null @@ -1,189 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim. - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Ignore generated lock files for GitHub Agentic Workflows: -[*.lock.yml] -charset = unset -end_of_line = unset -indent_style = unset -indent_size = unset -trim_trailing_whitespace = unset -insert_final_newline = unset - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 24b327f..0000000 --- a/.gitattributes +++ /dev/null @@ -1,68 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation - -.github/workflows/*.lock.yml linguist-generated=true merge=ours diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 13e3774..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/ndarray/matrix/float32) 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 6686a6b..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/ndarray/matrix/float32) 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 bfaf214..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: '2 2 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 83d50c4..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,821 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send notification to Zulip if job fails: - - name: 'Send notification to Zulip in case of failure' - # Pin action to full length commit SHA - uses: zulip/github-actions-zulip/send-message@e4c8f27c732ba9bd98ac6be0583096dea82feea5 # v1.0.2 - if: failure() - with: - api-key: ${{ secrets.ZULIP_API_KEY }} - email: 'github-actions-bot@stdlib.zulipchat.com' - organization-url: 'https://stdlib.zulipchat.com' - to: 'workflows-standalone' - type: 'stream' - topic: ${{ github.event.repository.name }} - content: | - :cross_mark: **${{ github.workflow }}** workflow failed - - **Repository:** [${{ github.repository }}](${{ github.server_url }}/${{ github.repository }}) - **Run:** [View workflow run](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}) - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -301,7 +292,7 @@ console.log( ndarray2array( v ) ); ## 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]. @@ -364,9 +355,9 @@ Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-matrix-float32/main/LICENSE -[@stdlib/array/buffer]: https://github.com/stdlib-js/array-buffer +[@stdlib/array/buffer]: https://github.com/stdlib-js/array-buffer/tree/esm -[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor +[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor/tree/esm
diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 03b1296..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,47 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2026 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var pkg = require( './../package.json' ).name; -var Float32Matrix = require( './../lib' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var arr; - var i; - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr = new Float32Matrix( 0, 0 ); - if ( arr.length !== 0 ) { - b.fail( 'should have length 0' ); - } - } - b.toc(); - if ( !isndarrayLike( arr ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.size.js b/benchmark/benchmark.size.js deleted file mode 100644 index 664d979..0000000 --- a/benchmark/benchmark.size.js +++ /dev/null @@ -1,95 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2026 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var Float32Matrix = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveIntegerArray} shape - array shape -* @returns {Function} benchmark function -*/ -function createBenchmark( shape ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var arr; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr = new Float32Matrix( shape ); - if ( typeof arr !== 'object' ) { - b.fail( 'should return an ndarray' ); - } - } - b.toc(); - if ( !isndarrayLike( arr ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var N; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - N = floor( pow( pow( 10, i ), 1.0/2.0 ) ); - f = createBenchmark( [ N, N ] ); - bench( format( '%s::equidimensional:size=%d', pkg, N*N ), f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 7b916fa..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/ndarray/matrix/float32" -%% click B href "https://github.com/stdlib-js/ndarray-matrix-float32/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-matrix-float32/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-matrix-float32/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-matrix-float32/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-matrix-float32/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/matrix/float32 -[production-url]: https://github.com/stdlib-js/ndarray-matrix-float32/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-matrix-float32/tree/deno -[deno-readme]: https://github.com/stdlib-js/ndarray-matrix-float32/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/ndarray-matrix-float32/tree/umd -[umd-readme]: https://github.com/stdlib-js/ndarray-matrix-float32/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/ndarray-matrix-float32/tree/esm -[esm-readme]: https://github.com/stdlib-js/ndarray-matrix-float32/blob/esm/README.md \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index 0b44231..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import ctor from '../docs/types/index'; -export = ctor; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 26cde3c..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var o=function(e,r){return function(){try{return r||e((r={exports:{}}).exports,r),r.exports}catch(i){throw (r=0, i)}};};var a=o(function(v,t){ -var s=require('@stdlib/ndarray-matrix-ctor/dist').factory,c=s("float32");t.exports=c -});var u=a();module.exports=u; -/** @license Apache-2.0 */ -//# sourceMappingURL=index.js.map diff --git a/dist/index.js.map b/dist/index.js.map deleted file mode 100644 index a628c0a..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/main.js", "../lib/index.js"], - "sourcesContent": ["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2026 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* 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( '@stdlib/ndarray-matrix-ctor' ).factory;\n\n\n// MAIN //\n\n/**\n* Returns a single-precision floating-point matrix (i.e., a two-dimensional ndarray).\n*\n* @name Float32Matrix\n* @type {Function}\n* @param {(NonNegativeInteger|NonNegativeIntegerArray|ArrayLikeObject|ArrayBuffer|Iterable)} [arg0] - shape, number of rows, array-like object, ArrayBuffer, or iterable\n* @param {NonNegativeInteger} [arg1] - number of columns or byte offset\n* @param {(NonNegativeInteger|NonNegativeIntegerArray)} [arg2] - shape or number of rows\n* @param {NonNegativeInteger} [arg3] - number of columns\n* @param {Options} [options] - function options\n* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only matrix\n* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed matrix dimensions\n* @param {StringArray} [options.submode=[options.mode]] - specifies how to handle subscripts which exceed array dimensions on a per dimension basis\n* @param {string} [options.order='row-major'] - memory layout (either row-major or column-major)\n* @throws {TypeError} first argument must be either a shape, integer, array-like object, ArrayBuffer, iterable, or options object\n* @throws {TypeError} must provide valid options\n* @returns {ndarray} two-dimensional ndarray\n*\n* @example\n* var getShape = require( '@stdlib/ndarray-shape' );\n*\n* var v = new Float32Matrix();\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 0, 0 ]\n*\n* @example\n* var getShape = require( '@stdlib/ndarray-shape' );\n*\n* var v = new Float32Matrix( [ 2, 2 ] );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 2 ]\n*\n* @example\n* var getShape = require( '@stdlib/ndarray-shape' );\n*\n* var v = new Float32Matrix( 2, 2 );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 2 ]\n*\n* @example\n* var getShape = require( '@stdlib/ndarray-shape' );\n*\n* var v = new Float32Matrix( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 2 ]\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var getShape = require( '@stdlib/ndarray-shape' );\n*\n* var buf = new ArrayBuffer( 32 );\n* var v = new Float32Matrix( buf );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 1, 8 ]\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var getShape = require( '@stdlib/ndarray-shape' );\n*\n* var buf = new ArrayBuffer( 32 );\n* var v = new Float32Matrix( buf, 16 );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 1, 4 ]\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var getShape = require( '@stdlib/ndarray-shape' );\n*\n* var buf = new ArrayBuffer( 64 );\n* var v = new Float32Matrix( buf, 16, [ 2, 1 ] );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 1 ]\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var getShape = require( '@stdlib/ndarray-shape' );\n*\n* var buf = new ArrayBuffer( 64 );\n* var v = new Float32Matrix( buf, 16, 2, 1 );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 1 ]\n*/\nvar Float32Matrix = factory( 'float32' );\n\n\n// EXPORTS //\n\nmodule.exports = Float32Matrix;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2026 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 a single-precision floating-point matrix (i.e., a two-dimensional ndarray).\n*\n* @module @stdlib/ndarray-matrix-float32\n*\n* @example\n* var getShape = require( '@stdlib/ndarray-shape' );\n* var Float32Matrix = require( '@stdlib/ndarray-matrix-float32' );\n*\n* var v = new Float32Matrix();\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 0, 0 ]\n*\n* @example\n* var getShape = require( '@stdlib/ndarray-shape' );\n* var Float32Matrix = require( '@stdlib/ndarray-matrix-float32' );\n*\n* var v = new Float32Matrix( [ 2, 2 ] );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 2 ]\n*\n* @example\n* var getShape = require( '@stdlib/ndarray-shape' );\n* var Float32Matrix = require( '@stdlib/ndarray-matrix-float32' );\n*\n* var v = new Float32Matrix( 2, 2 );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 2 ]\n*\n* @example\n* var getShape = require( '@stdlib/ndarray-shape' );\n* var Float32Matrix = require( '@stdlib/ndarray-matrix-float32' );\n*\n* var v = new Float32Matrix( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 2 ]\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var getShape = require( '@stdlib/ndarray-shape' );\n* var Float32Matrix = require( '@stdlib/ndarray-matrix-float32' );\n*\n* var buf = new ArrayBuffer( 32 );\n* var v = new Float32Matrix( buf );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 1, 8 ]\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var getShape = require( '@stdlib/ndarray-shape' );\n* var Float32Matrix = require( '@stdlib/ndarray-matrix-float32' );\n*\n* var buf = new ArrayBuffer( 32 );\n* var v = new Float32Matrix( buf, 16 );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 1, 4 ]\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var getShape = require( '@stdlib/ndarray-shape' );\n* var Float32Matrix = require( '@stdlib/ndarray-matrix-float32' );\n*\n* var buf = new ArrayBuffer( 64 );\n* var v = new Float32Matrix( buf, 16, [ 2, 1 ] );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 1 ]\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var getShape = require( '@stdlib/ndarray-shape' );\n* var Float32Matrix = require( '@stdlib/ndarray-matrix-float32' );\n*\n* var buf = new ArrayBuffer( 64 );\n* var v = new Float32Matrix( buf, 16, 2, 1 );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 1 ]\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "iIAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,QAAS,6BAA8B,EAAE,QAuGnDC,EAAgBD,EAAS,SAAU,EAKvCD,EAAO,QAAUE,ICdjB,IAAIC,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "factory", "Float32Matrix", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index b0bbaa9..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,361 +0,0 @@ - -{{alias}}( [options] ) - Returns a two-dimensional single-precision floating-point ndarray. - - Parameters - ---------- - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran-style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle indices which exceed array dimensions. If equal - to 'throw', an ndarray instance throws an error when an index exceeds - array dimensions. If equal to 'normalize', an ndarray instance - normalizes negative indices and throws an error when an index exceeds - array dimensions. If equal to 'wrap', an ndarray instance wraps around - indices exceeding array dimensions using modulo arithmetic. If equal to - 'clamp', an ndarray instance sets an index exceeding array dimensions - to either `0` (minimum index) or the maximum index. Default: 'throw'. - - options.submode: Array (optional) - Specifies how to handle subscripts which exceed array dimensions. If a - mode for a corresponding dimension is equal to 'throw', an ndarray - instance throws an error when a subscript exceeds array dimensions. If - equal to 'normalize', an ndarray instance normalizes negative - subscripts and throws an error when a subscript exceeds array - dimensions. If equal to 'wrap', an ndarray instance wraps around - subscripts exceeding array dimensions using modulo arithmetic. If equal - to 'clamp', an ndarray instance sets a subscript exceeding array - dimensions to either `0` (minimum index) or the maximum index. If the - number of modes is less than the number of dimensions, an ndarray - instance recycles modes using modulo arithmetic. - - Default: [ options.mode ]. - - options.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A two-dimensional ndarray. - - Examples - -------- - > var arr = {{alias}}() - - - -{{alias}}( shape[, options] ) - Returns a two-dimensional single-precision floating-point ndarray having a - specified shape. - - Parameters - ---------- - shape: ArrayLikeObject - Array shape. Must contain exactly two elements. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran-style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle indices which exceed array dimensions. If equal - to 'throw', an ndarray instance throws an error when an index exceeds - array dimensions. If equal to 'normalize', an ndarray instance - normalizes negative indices and throws an error when an index exceeds - array dimensions. If equal to 'wrap', an ndarray instance wraps around - indices exceeding array dimensions using modulo arithmetic. If equal to - 'clamp', an ndarray instance sets an index exceeding array dimensions - to either `0` (minimum index) or the maximum index. Default: 'throw'. - - options.submode: Array (optional) - Specifies how to handle subscripts which exceed array dimensions. If a - mode for a corresponding dimension is equal to 'throw', an ndarray - instance throws an error when a subscript exceeds array dimensions. If - equal to 'normalize', an ndarray instance normalizes negative - subscripts and throws an error when a subscript exceeds array - dimensions. If equal to 'wrap', an ndarray instance wraps around - subscripts exceeding array dimensions using modulo arithmetic. If equal - to 'clamp', an ndarray instance sets a subscript exceeding array - dimensions to either `0` (minimum index) or the maximum index. If the - number of modes is less than the number of dimensions, an ndarray - instance recycles modes using modulo arithmetic. - - Default: [ options.mode ]. - - options.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A two-dimensional ndarray. - - Examples - -------- - > var arr = {{alias}}( [ 2, 2 ] ) - - - -{{alias}}( M, N[, options] ) - Returns a two-dimensional single-precision floating-point ndarray having a - specified shape. - - Parameters - ---------- - M: integer - Number of rows. - - N: integer - Number of columns. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran-style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle indices which exceed array dimensions. If equal - to 'throw', an ndarray instance throws an error when an index exceeds - array dimensions. If equal to 'normalize', an ndarray instance - normalizes negative indices and throws an error when an index exceeds - array dimensions. If equal to 'wrap', an ndarray instance wraps around - indices exceeding array dimensions using modulo arithmetic. If equal to - 'clamp', an ndarray instance sets an index exceeding array dimensions - to either `0` (minimum index) or the maximum index. Default: 'throw'. - - options.submode: Array (optional) - Specifies how to handle subscripts which exceed array dimensions. If a - mode for a corresponding dimension is equal to 'throw', an ndarray - instance throws an error when a subscript exceeds array dimensions. If - equal to 'normalize', an ndarray instance normalizes negative - subscripts and throws an error when a subscript exceeds array - dimensions. If equal to 'wrap', an ndarray instance wraps around - subscripts exceeding array dimensions using modulo arithmetic. If equal - to 'clamp', an ndarray instance sets a subscript exceeding array - dimensions to either `0` (minimum index) or the maximum index. If the - number of modes is less than the number of dimensions, an ndarray - instance recycles modes using modulo arithmetic. - - Default: [ options.mode ]. - - options.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A two-dimensional ndarray. - - Examples - -------- - > var arr = {{alias}}( 2, 2 ) - - - -{{alias}}( obj[, options] ) - Creates a two-dimensional single-precision floating-point ndarray from an - array-like object or iterable. - - Parameters - ---------- - obj: Object - Array-like object or iterable from which to generate an ndarray. If an - array-like object, the value must be a nested array (i.e., an array-like - object of array-like objects), where each nested array must have the - same number of elements. If an iterable, the iterable must return array- - like objects, each of which must have the same number of elements. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran-style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle indices which exceed array dimensions. If equal - to 'throw', an ndarray instance throws an error when an index exceeds - array dimensions. If equal to 'normalize', an ndarray instance - normalizes negative indices and throws an error when an index exceeds - array dimensions. If equal to 'wrap', an ndarray instance wraps around - indices exceeding array dimensions using modulo arithmetic. If equal to - 'clamp', an ndarray instance sets an index exceeding array dimensions - to either `0` (minimum index) or the maximum index. Default: 'throw'. - - options.submode: Array (optional) - Specifies how to handle subscripts which exceed array dimensions. If a - mode for a corresponding dimension is equal to 'throw', an ndarray - instance throws an error when a subscript exceeds array dimensions. If - equal to 'normalize', an ndarray instance normalizes negative - subscripts and throws an error when a subscript exceeds array - dimensions. If equal to 'wrap', an ndarray instance wraps around - subscripts exceeding array dimensions using modulo arithmetic. If equal - to 'clamp', an ndarray instance sets a subscript exceeding array - dimensions to either `0` (minimum index) or the maximum index. If the - number of modes is less than the number of dimensions, an ndarray - instance recycles modes using modulo arithmetic. - - Default: [ options.mode ]. - - options.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A two-dimensional ndarray. - - Examples - -------- - > var v = [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]; - > var arr = {{alias}}( v ) - - - -{{alias}}( buffer[, byteOffset[, shape]][, options] ) - Returns a two-dimensional single-precision floating-point ndarray view of an - ArrayBuffer. - - Parameters - ---------- - buffer: ArrayBuffer - Underlying ArrayBuffer. - - byteOffset: integer (optional) - Integer byte offset specifying the location of the first indexed - element. Default: 0. - - shape: ArrayLikeObject (optional) - Array shape. Must contain exactly two elements. If not provided, the - view spans from the byteOffset to the end of the underlying ArrayBuffer - and the first dimension of the returned ndarray has a size of one. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran-style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle indices which exceed array dimensions. If equal - to 'throw', an ndarray instance throws an error when an index exceeds - array dimensions. If equal to 'normalize', an ndarray instance - normalizes negative indices and throws an error when an index exceeds - array dimensions. If equal to 'wrap', an ndarray instance wraps around - indices exceeding array dimensions using modulo arithmetic. If equal to - 'clamp', an ndarray instance sets an index exceeding array dimensions - to either `0` (minimum index) or the maximum index. Default: 'throw'. - - options.submode: Array (optional) - Specifies how to handle subscripts which exceed array dimensions. If a - mode for a corresponding dimension is equal to 'throw', an ndarray - instance throws an error when a subscript exceeds array dimensions. If - equal to 'normalize', an ndarray instance normalizes negative - subscripts and throws an error when a subscript exceeds array - dimensions. If equal to 'wrap', an ndarray instance wraps around - subscripts exceeding array dimensions using modulo arithmetic. If equal - to 'clamp', an ndarray instance sets a subscript exceeding array - dimensions to either `0` (minimum index) or the maximum index. If the - number of modes is less than the number of dimensions, an ndarray - instance recycles modes using modulo arithmetic. - - Default: [ options.mode ]. - - options.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A two-dimensional ndarray. - - Examples - -------- - > var buf = new {{alias:@stdlib/array/buffer}}( 32 ); - > var arr = {{alias}}( buf, 0, [ 8, 1 ] ) - - - -{{alias}}( buffer[, byteOffset[, M, N]][, options] ) - Returns a two-dimensional single-precision floating-point ndarray view of an - ArrayBuffer. - - If `M` and `N` are not provided, the returned ndarray view spans from the - byteOffset to the end of the underlying ArrayBuffer. - - Parameters - ---------- - buffer: ArrayBuffer - Underlying ArrayBuffer. - - byteOffset: integer (optional) - Integer byte offset specifying the location of the first indexed - element. Default: 0. - - M: integer (optional) - Number of rows. - - N: integer (optional) - Number of columns. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran-style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle indices which exceed array dimensions. If equal - to 'throw', an ndarray instance throws an error when an index exceeds - array dimensions. If equal to 'normalize', an ndarray instance - normalizes negative indices and throws an error when an index exceeds - array dimensions. If equal to 'wrap', an ndarray instance wraps around - indices exceeding array dimensions using modulo arithmetic. If equal to - 'clamp', an ndarray instance sets an index exceeding array dimensions - to either `0` (minimum index) or the maximum index. Default: 'throw'. - - options.submode: Array (optional) - Specifies how to handle subscripts which exceed array dimensions. If a - mode for a corresponding dimension is equal to 'throw', an ndarray - instance throws an error when a subscript exceeds array dimensions. If - equal to 'normalize', an ndarray instance normalizes negative - subscripts and throws an error when a subscript exceeds array - dimensions. If equal to 'wrap', an ndarray instance wraps around - subscripts exceeding array dimensions using modulo arithmetic. If equal - to 'clamp', an ndarray instance sets a subscript exceeding array - dimensions to either `0` (minimum index) or the maximum index. If the - number of modes is less than the number of dimensions, an ndarray - instance recycles modes using modulo arithmetic. - - Default: [ options.mode ]. - - options.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A two-dimensional ndarray. - - Examples - -------- - > var buf = new {{alias:@stdlib/array/buffer}}( 32 ); - > var arr = {{alias}}( buf, 0, 4, 1 ) - - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 0e6cc3d..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,100 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2026 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 ArrayBuffer = require( '@stdlib/array-buffer' ); -import Float32Matrix = require( './index' ); - - -// TESTS // - -// The function returns an ndarray... -{ - new Float32Matrix(); // $ExpectType float32ndarray - new Float32Matrix( {} ); // $ExpectType float32ndarray - - new Float32Matrix( 10, 10 ); // $ExpectType float32ndarray - new Float32Matrix( 10, 10, {} ); // $ExpectType float32ndarray - - new Float32Matrix( [ 10, 10 ] ); // $ExpectType float32ndarray - new Float32Matrix( [ 10, 10 ], {} ); // $ExpectType float32ndarray - - new Float32Matrix( [ [ 1, 2 ], [ 3, 4 ] ] ); // $ExpectType float32ndarray - new Float32Matrix( [ [ 1, 2 ], [ 3, 4 ] ], {} ); // $ExpectType float32ndarray - - new Float32Matrix( new ArrayBuffer( 10 ) ); // $ExpectType float32ndarray - new Float32Matrix( new ArrayBuffer( 10 ), {} ); // $ExpectType float32ndarray - - new Float32Matrix( new ArrayBuffer( 10 ), 8 ); // $ExpectType float32ndarray - new Float32Matrix( new ArrayBuffer( 10 ), 8, {} ); // $ExpectType float32ndarray - - new Float32Matrix( new ArrayBuffer( 10 ), 8, [ 1, 1 ] ); // $ExpectType float32ndarray - new Float32Matrix( new ArrayBuffer( 10 ), 8, [ 1, 1 ], {} ); // $ExpectType float32ndarray - - new Float32Matrix( new ArrayBuffer( 10 ), 8, 1, 1 ); // $ExpectType float32ndarray - new Float32Matrix( new ArrayBuffer( 10 ), 8, 1, 1, {} ); // $ExpectType float32ndarray - - const matrix = Float32Matrix; - matrix(); // $ExpectType float32ndarray - matrix( {} ); // $ExpectType float32ndarray - - matrix( 10, 10 ); // $ExpectType float32ndarray - matrix( 10, 10, {} ); // $ExpectType float32ndarray - - matrix( [ 10, 10 ] ); // $ExpectType float32ndarray - matrix( [ 10, 10 ], {} ); // $ExpectType float32ndarray - - matrix( [ [ 1, 2 ], [ 3, 4 ] ] ); // $ExpectType float32ndarray - matrix( [ [ 1, 2 ], [ 3, 4 ] ], {} ); // $ExpectType float32ndarray - - matrix( new ArrayBuffer( 10 ) ); // $ExpectType float32ndarray - matrix( new ArrayBuffer( 10 ), {} ); // $ExpectType float32ndarray - - matrix( new ArrayBuffer( 10 ), 8 ); // $ExpectType float32ndarray - matrix( new ArrayBuffer( 10 ), 8, {} ); // $ExpectType float32ndarray - - matrix( new ArrayBuffer( 10 ), 8, [ 1, 1 ] ); // $ExpectType float32ndarray - matrix( new ArrayBuffer( 10 ), 8, [ 1, 1 ], {} ); // $ExpectType float32ndarray - - matrix( new ArrayBuffer( 10 ), 8, 1, 1 ); // $ExpectType float32ndarray - matrix( new ArrayBuffer( 10 ), 8, 1, 1, {} ); // $ExpectType float32ndarray -} - -// The compiler throws an error if the function is provided a first argument which is not a number, array-like object, iterable, or options object... -{ - new Float32Matrix( true ); // $ExpectError - new Float32Matrix( false ); // $ExpectError - new Float32Matrix( null ); // $ExpectError - new Float32Matrix( ( x: number ): number => x ); // $ExpectError - - const matrix = Float32Matrix; - matrix( true ); // $ExpectError - matrix( false ); // $ExpectError - matrix( null ); // $ExpectError - matrix( ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const buf = new ArrayBuffer( 32 ); - new Float32Matrix( buf, 8, 2, 1, {}, {} ); // $ExpectError - new Float32Matrix( buf, 8, [ 2, 1 ], {}, {} ); // $ExpectError - - const matrix = Float32Matrix; - matrix( buf, 8, 2, 1, {}, {} ); // $ExpectError - matrix( buf, 8, [ 2, 1 ], {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index ca82258..0000000 --- a/examples/index.js +++ /dev/null @@ -1,51 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2026 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); -var sum = require( '@stdlib/blas-ext-sum' ); -var map = require( '@stdlib/ndarray-map' ); -var ndarray2array = require( '@stdlib/ndarray-to-array' ); -var Float32Matrix = require( './../lib' ); - -// Create a matrix containing random values: -var x = new Float32Matrix([ - discreteUniform( 10, 0, 100 ), - discreteUniform( 10, 0, 20 ) -]); - -// Compute the sum along the columns: -var v = sum( x, { - 'dims': [ -1 ] -}); -console.log( ndarray2array( v ) ); - -// Define a function which applies a threshold to individual values: -function threshold( v ) { - return ( v > 10 ) ? v : 0; -} - -// Apply threshold: -var y = map( x, threshold ); - -// Recompute the sum along the columns: -v = sum( y, { - 'dims': [ -1 ] -}); -console.log( ndarray2array( v ) ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 99% rename from docs/types/index.d.ts rename to index.d.ts index 5d30fac..fb5eb97 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -20,7 +20,7 @@ /* eslint-disable @typescript-eslint/unified-signatures */ -/// +/// import { Order, Mode, float32ndarray, Shape2D } from '@stdlib/types/ndarray'; import { Collection, AccessorArrayLike, ArrayLike } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..d687205 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import{factory as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-matrix-ctor@esm/index.mjs";var r=t("float32");export{r as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..1fc582f --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2026 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* 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 as factory } from '@stdlib/ndarray-matrix-ctor';\n\n\n// MAIN //\n\n/**\n* Returns a single-precision floating-point matrix (i.e., a two-dimensional ndarray).\n*\n* @name Float32Matrix\n* @type {Function}\n* @param {(NonNegativeInteger|NonNegativeIntegerArray|ArrayLikeObject|ArrayBuffer|Iterable)} [arg0] - shape, number of rows, array-like object, ArrayBuffer, or iterable\n* @param {NonNegativeInteger} [arg1] - number of columns or byte offset\n* @param {(NonNegativeInteger|NonNegativeIntegerArray)} [arg2] - shape or number of rows\n* @param {NonNegativeInteger} [arg3] - number of columns\n* @param {Options} [options] - function options\n* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only matrix\n* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed matrix dimensions\n* @param {StringArray} [options.submode=[options.mode]] - specifies how to handle subscripts which exceed array dimensions on a per dimension basis\n* @param {string} [options.order='row-major'] - memory layout (either row-major or column-major)\n* @throws {TypeError} first argument must be either a shape, integer, array-like object, ArrayBuffer, iterable, or options object\n* @throws {TypeError} must provide valid options\n* @returns {ndarray} two-dimensional ndarray\n*\n* @example\n* import getShape from '@stdlib/ndarray-shape';\n*\n* var v = new Float32Matrix();\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 0, 0 ]\n*\n* @example\n* import getShape from '@stdlib/ndarray-shape';\n*\n* var v = new Float32Matrix( [ 2, 2 ] );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 2 ]\n*\n* @example\n* import getShape from '@stdlib/ndarray-shape';\n*\n* var v = new Float32Matrix( 2, 2 );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 2 ]\n*\n* @example\n* import getShape from '@stdlib/ndarray-shape';\n*\n* var v = new Float32Matrix( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 2 ]\n*\n* @example\n* import ArrayBuffer from '@stdlib/array-buffer';\n* import getShape from '@stdlib/ndarray-shape';\n*\n* var buf = new ArrayBuffer( 32 );\n* var v = new Float32Matrix( buf );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 1, 8 ]\n*\n* @example\n* import ArrayBuffer from '@stdlib/array-buffer';\n* import getShape from '@stdlib/ndarray-shape';\n*\n* var buf = new ArrayBuffer( 32 );\n* var v = new Float32Matrix( buf, 16 );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 1, 4 ]\n*\n* @example\n* import ArrayBuffer from '@stdlib/array-buffer';\n* import getShape from '@stdlib/ndarray-shape';\n*\n* var buf = new ArrayBuffer( 64 );\n* var v = new Float32Matrix( buf, 16, [ 2, 1 ] );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 1 ]\n*\n* @example\n* import ArrayBuffer from '@stdlib/array-buffer';\n* import getShape from '@stdlib/ndarray-shape';\n*\n* var buf = new ArrayBuffer( 64 );\n* var v = new Float32Matrix( buf, 16, 2, 1 );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 1 ]\n*/\nvar Float32Matrix = factory( 'float32' );\n\n\n// EXPORTS //\n\nexport default Float32Matrix;\n"],"names":["Float32Matrix","factory"],"mappings":";;kGA6HG,IAACA,EAAgBC,EAAS"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index b62f3e6..0000000 --- a/lib/index.js +++ /dev/null @@ -1,122 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2026 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 a single-precision floating-point matrix (i.e., a two-dimensional ndarray). -* -* @module @stdlib/ndarray-matrix-float32 -* -* @example -* var getShape = require( '@stdlib/ndarray-shape' ); -* var Float32Matrix = require( '@stdlib/ndarray-matrix-float32' ); -* -* var v = new Float32Matrix(); -* // returns -* -* var len = getShape( v ); -* // returns [ 0, 0 ] -* -* @example -* var getShape = require( '@stdlib/ndarray-shape' ); -* var Float32Matrix = require( '@stdlib/ndarray-matrix-float32' ); -* -* var v = new Float32Matrix( [ 2, 2 ] ); -* // returns -* -* var len = getShape( v ); -* // returns [ 2, 2 ] -* -* @example -* var getShape = require( '@stdlib/ndarray-shape' ); -* var Float32Matrix = require( '@stdlib/ndarray-matrix-float32' ); -* -* var v = new Float32Matrix( 2, 2 ); -* // returns -* -* var len = getShape( v ); -* // returns [ 2, 2 ] -* -* @example -* var getShape = require( '@stdlib/ndarray-shape' ); -* var Float32Matrix = require( '@stdlib/ndarray-matrix-float32' ); -* -* var v = new Float32Matrix( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ); -* // returns -* -* var len = getShape( v ); -* // returns [ 2, 2 ] -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var getShape = require( '@stdlib/ndarray-shape' ); -* var Float32Matrix = require( '@stdlib/ndarray-matrix-float32' ); -* -* var buf = new ArrayBuffer( 32 ); -* var v = new Float32Matrix( buf ); -* // returns -* -* var len = getShape( v ); -* // returns [ 1, 8 ] -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var getShape = require( '@stdlib/ndarray-shape' ); -* var Float32Matrix = require( '@stdlib/ndarray-matrix-float32' ); -* -* var buf = new ArrayBuffer( 32 ); -* var v = new Float32Matrix( buf, 16 ); -* // returns -* -* var len = getShape( v ); -* // returns [ 1, 4 ] -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var getShape = require( '@stdlib/ndarray-shape' ); -* var Float32Matrix = require( '@stdlib/ndarray-matrix-float32' ); -* -* var buf = new ArrayBuffer( 64 ); -* var v = new Float32Matrix( buf, 16, [ 2, 1 ] ); -* // returns -* -* var len = getShape( v ); -* // returns [ 2, 1 ] -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var getShape = require( '@stdlib/ndarray-shape' ); -* var Float32Matrix = require( '@stdlib/ndarray-matrix-float32' ); -* -* var buf = new ArrayBuffer( 64 ); -* var v = new Float32Matrix( buf, 16, 2, 1 ); -* // returns -* -* var len = getShape( v ); -* // returns [ 2, 1 ] -*/ - -// MODULES // - -var main = require( './main.js' ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index a1e2693..0000000 --- a/lib/main.js +++ /dev/null @@ -1,131 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2026 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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( '@stdlib/ndarray-matrix-ctor' ).factory; - - -// MAIN // - -/** -* Returns a single-precision floating-point matrix (i.e., a two-dimensional ndarray). -* -* @name Float32Matrix -* @type {Function} -* @param {(NonNegativeInteger|NonNegativeIntegerArray|ArrayLikeObject|ArrayBuffer|Iterable)} [arg0] - shape, number of rows, array-like object, ArrayBuffer, or iterable -* @param {NonNegativeInteger} [arg1] - number of columns or byte offset -* @param {(NonNegativeInteger|NonNegativeIntegerArray)} [arg2] - shape or number of rows -* @param {NonNegativeInteger} [arg3] - number of columns -* @param {Options} [options] - function options -* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only matrix -* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed matrix dimensions -* @param {StringArray} [options.submode=[options.mode]] - specifies how to handle subscripts which exceed array dimensions on a per dimension basis -* @param {string} [options.order='row-major'] - memory layout (either row-major or column-major) -* @throws {TypeError} first argument must be either a shape, integer, array-like object, ArrayBuffer, iterable, or options object -* @throws {TypeError} must provide valid options -* @returns {ndarray} two-dimensional ndarray -* -* @example -* var getShape = require( '@stdlib/ndarray-shape' ); -* -* var v = new Float32Matrix(); -* // returns -* -* var len = getShape( v ); -* // returns [ 0, 0 ] -* -* @example -* var getShape = require( '@stdlib/ndarray-shape' ); -* -* var v = new Float32Matrix( [ 2, 2 ] ); -* // returns -* -* var len = getShape( v ); -* // returns [ 2, 2 ] -* -* @example -* var getShape = require( '@stdlib/ndarray-shape' ); -* -* var v = new Float32Matrix( 2, 2 ); -* // returns -* -* var len = getShape( v ); -* // returns [ 2, 2 ] -* -* @example -* var getShape = require( '@stdlib/ndarray-shape' ); -* -* var v = new Float32Matrix( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ); -* // returns -* -* var len = getShape( v ); -* // returns [ 2, 2 ] -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var getShape = require( '@stdlib/ndarray-shape' ); -* -* var buf = new ArrayBuffer( 32 ); -* var v = new Float32Matrix( buf ); -* // returns -* -* var len = getShape( v ); -* // returns [ 1, 8 ] -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var getShape = require( '@stdlib/ndarray-shape' ); -* -* var buf = new ArrayBuffer( 32 ); -* var v = new Float32Matrix( buf, 16 ); -* // returns -* -* var len = getShape( v ); -* // returns [ 1, 4 ] -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var getShape = require( '@stdlib/ndarray-shape' ); -* -* var buf = new ArrayBuffer( 64 ); -* var v = new Float32Matrix( buf, 16, [ 2, 1 ] ); -* // returns -* -* var len = getShape( v ); -* // returns [ 2, 1 ] -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var getShape = require( '@stdlib/ndarray-shape' ); -* -* var buf = new ArrayBuffer( 64 ); -* var v = new Float32Matrix( buf, 16, 2, 1 ); -* // returns -* -* var len = getShape( v ); -* // returns [ 2, 1 ] -*/ -var Float32Matrix = factory( 'float32' ); - - -// EXPORTS // - -module.exports = Float32Matrix; diff --git a/package.json b/package.json index d6f3604..fe36b21 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.0.0", "description": "Create a single-precision floating-point matrix (i.e., a two-dimensional ndarray).", "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,47 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/ndarray-matrix-ctor": "github:stdlib-js/ndarray-matrix-ctor#main", - "@stdlib/types": "^0.5.1" - }, - "devDependencies": { - "@stdlib/array-buffer": "^0.2.3", - "@stdlib/array-float32": "^0.2.3", - "@stdlib/assert-is-ndarray-like": "^0.2.3", - "@stdlib/assert-is-ndarray-like-with-data-type": "^0.1.1", - "@stdlib/assert-is-same-float32array": "^0.2.3", - "@stdlib/blas-ext-sum": "^0.1.1", - "@stdlib/math-base-special-floor": "^0.2.4", - "@stdlib/math-base-special-pow": "^0.3.1", - "@stdlib/ndarray-base-assert-is-read-only": "^0.2.3", - "@stdlib/ndarray-data-buffer": "^0.2.3", - "@stdlib/ndarray-map": "^0.1.1", - "@stdlib/ndarray-order": "^0.2.3", - "@stdlib/ndarray-shape": "^0.2.3", - "@stdlib/ndarray-to-array": "^0.2.2", - "@stdlib/random-array-discrete-uniform": "^0.2.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.3", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.3" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..0807e84 --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 65fdf78..0000000 --- a/test/test.js +++ /dev/null @@ -1,1394 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2026 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable no-new */ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var isndarrayLikeWithDataType = require( '@stdlib/assert-is-ndarray-like-with-data-type' ); -var isSameFloat32Array = require( '@stdlib/assert-is-same-float32array' ); -var isReadOnly = require( '@stdlib/ndarray-base-assert-is-read-only' ); -var ArrayBuffer = require( '@stdlib/array-buffer' ); -var Float32Array = require( '@stdlib/array-float32' ); -var getData = require( '@stdlib/ndarray-data-buffer' ); -var getShape = require( '@stdlib/ndarray-shape' ); -var getOrder = require( '@stdlib/ndarray-order' ); -var Float32Matrix = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof Float32Matrix, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if provided an invalid first argument', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1 ], - [ 1, 2, 3 ], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1 ], - [ 1, 2, 3 ], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( value, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (second argument)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( value, 0 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (second argument, options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( value, 0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (byteoffset, shape)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( value, 0, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (byteoffset, shape, options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( value, 0, [ 0, 0 ], {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (byteoffset, M, N)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( value, 0, 0, 0 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (byteoffset, M, N, options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( value, 0, 0, 0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid byte offset argument', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( new ArrayBuffer( 8 ), value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid byte offset argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( new ArrayBuffer( 8 ), value, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid byte offset argument (shape)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( new ArrayBuffer( 8 ), value, [ 1, 1 ] ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid byte offset argument (shape, options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( new ArrayBuffer( 8 ), value, [ 1, 1 ], {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid byte offset argument (M, N)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( new ArrayBuffer( 8 ), value, 1, 1 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid byte offset argument (M, N, options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( new ArrayBuffer( 8 ), value, 1, 1, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1 ], - [ 1, 1, 1 ], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( new ArrayBuffer( 8 ), 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1 ], - [ 1, 1, 1 ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( new ArrayBuffer( 8 ), 0, value, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid `M` argument', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1 ], - [ 1, 1, 1 ], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( new ArrayBuffer( 8 ), 0, value, 1 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid `M` argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1 ], - [ 1, 1, 1 ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( new ArrayBuffer( 8 ), 0, value, 1, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid `N` argument', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1 ], - [ 1, 1, 1 ], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( new ArrayBuffer( 8 ), 0, 1, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid `N` argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1 ], - [ 1, 1, 1 ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( new ArrayBuffer( 8 ), 0, 1, value, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (shape)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( [ 3, 3 ], value ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (M, N)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( 3, 3, value ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (array)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ], value ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (arraybuffer)', function test( t ) { - var values; - var i; - - values = [ - '5', - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( new ArrayBuffer( 8 ), value ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (arraybuffer, byteoffset)', function test( t ) { - var values; - var i; - - values = [ - '5', - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( new ArrayBuffer( 8 ), 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (arraybuffer, byteoffset, shape)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( new ArrayBuffer( 8 ), 0, [ 1, 1 ], value ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (arraybuffer, byteoffset, M, N)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( new ArrayBuffer( 8 ), 0, 1, 1, value ); - }; - } -}); - -tape( 'the function throws an error if provided an `order` option which is not a recognized order', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'ROW', - 'row', - 'col-major', - 'col', - 'major', - 'minor', - null - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix({ - 'order': value - }); - }; - } -}); - -tape( 'the function throws an error if provided a `mode` option which is not a recognized mode', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'THROW', - 5, - null, - true, - false, - [], - {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix({ - 'mode': value - }); - }; - } -}); - -tape( 'the function throws an error if provided a `mode` option which is not a recognized submode', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'THROW', - 5, - null, - true, - false, - [], - {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix({ - 'submode': [ value ] - }); - }; - } -}); - -tape( 'the function throws an error if provided a `readonly` option which is not a boolean', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - null, - void 0, - [], - {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix({ - 'readonly': value - }); - }; - } -}); - -tape( 'the function returns a two-dimensional ndarray', function test( t ) { - var arr; - - arr = new Float32Matrix(); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 0, 0 ], 'returns expected value' ); - - arr = new Float32Matrix( {} ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a two-dimensional ndarray (shape)', function test( t ) { - var arr; - - arr = new Float32Matrix( [ 3, 3 ] ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 3, 3 ], 'returns expected value' ); - - arr = new Float32Matrix( [ 3, 3 ], {} ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 3, 3 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a two-dimensional ndarray (M, N)', function test( t ) { - var arr; - - arr = new Float32Matrix( 3, 3 ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 3, 3 ], 'returns expected value' ); - - arr = new Float32Matrix( 3, 3, {} ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 3, 3 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a two-dimensional ndarray (array)', function test( t ) { - var arr; - var out; - - arr = [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]; - - out = new Float32Matrix( arr ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( out ), [ 2, 2 ], 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( [ 1.0, 2.0, 3.0, 4.0 ] ) ), true, 'returns expected value' ); - - out = new Float32Matrix( arr, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( out ), [ 2, 2 ], 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( [ 1.0, 2.0, 3.0, 4.0 ] ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a two-dimensional ndarray (arraybuffer)', function test( t ) { - var buf; - var out; - - buf = new ArrayBuffer( 16 ); - - out = new Float32Matrix( buf ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( out ), [ 1, 4 ], 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf ) ), true, 'returns expected value' ); - - out = new Float32Matrix( buf, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( out ), [ 1, 4 ], 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a two-dimensional ndarray (arraybuffer, byteoffset)', function test( t ) { - var buf; - var out; - - buf = new ArrayBuffer( 64 ); - - out = new Float32Matrix( buf, 8 ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( out ), [ 1, 14 ], 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf, 8 ) ), true, 'returns expected value' ); - - out = new Float32Matrix( buf, 8, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( out ), [ 1, 14 ], 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf, 8 ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a two-dimensional ndarray (arraybuffer, byteoffset, shape)', function test( t ) { - var buf; - var out; - - buf = new ArrayBuffer( 64 ); - - out = new Float32Matrix( buf, 8, [ 2, 1 ] ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( out ), [ 2, 1 ], 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf, 8, 2 ) ), true, 'returns expected value' ); - - out = new Float32Matrix( buf, 8, [ 2, 1 ], {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( out ), [ 2, 1 ], 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf, 8, 2 ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a two-dimensional ndarray (arraybuffer, byteoffset, M, N)', function test( t ) { - var buf; - var out; - - buf = new ArrayBuffer( 64 ); - - out = new Float32Matrix( buf, 8, 2, 1 ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( out ), [ 2, 1 ], 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf, 8, 2 ) ), true, 'returns expected value' ); - - out = new Float32Matrix( buf, 8, 2, 1, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( out ), [ 2, 1 ], 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf, 8, 2 ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout', function test( t ) { - var arr; - - arr = new Float32Matrix({ - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 0, 0 ], 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Float32Matrix({ - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 0, 0 ], 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (shape)', function test( t ) { - var arr; - - arr = new Float32Matrix( [ 3, 3 ], { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 3, 3 ], 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Float32Matrix( [ 3, 3 ], { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 3, 3 ], 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (array)', function test( t ) { - var arr; - - arr = new Float32Matrix( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ], { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 2, 2 ], 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Float32Matrix( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ], { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 2, 2 ], 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (arraybuffer)', function test( t ) { - var arr; - - arr = new Float32Matrix( new ArrayBuffer( 64 ), { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 1, 16 ], 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Float32Matrix( new ArrayBuffer( 64 ), { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 1, 16 ], 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (arraybuffer, byteoffset)', function test( t ) { - var arr; - - arr = new Float32Matrix( new ArrayBuffer( 64 ), 8, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 1, 14 ], 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Float32Matrix( new ArrayBuffer( 64 ), 8, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 1, 14 ], 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (arraybuffer, byteoffset, shape)', function test( t ) { - var arr; - - arr = new Float32Matrix( new ArrayBuffer( 64 ), 8, [ 2, 1 ], { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 2, 1 ], 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Float32Matrix( new ArrayBuffer( 64 ), 8, [ 2, 1 ], { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 2, 1 ], 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (arraybuffer, byteoffset, M, N)', function test( t ) { - var arr; - - arr = new Float32Matrix( new ArrayBuffer( 64 ), 8, 2, 1, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 2, 1 ], 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Float32Matrix( new ArrayBuffer( 64 ), 8, 2, 1, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 2, 1 ], 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning read-only ndarrays', function test( t ) { - var arr; - - arr = new Float32Matrix({ - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 0, 0 ], 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning read-only ndarrays (shape)', function test( t ) { - var arr; - - arr = new Float32Matrix( [ 3, 3 ], { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 3, 3 ], 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning read-only ndarrays (array)', function test( t ) { - var arr; - - arr = new Float32Matrix( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ], { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 2, 2 ], 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning read-only ndarrays (arraybuffer)', function test( t ) { - var arr; - - arr = new Float32Matrix( new ArrayBuffer( 64 ), { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 1, 16 ], 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning read-only ndarrays (arraybuffer, byteoffset)', function test( t ) { - var arr; - - arr = new Float32Matrix( new ArrayBuffer( 64 ), 8, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 1, 14 ], 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning read-only ndarrays (arraybuffer, byteoffset, shape)', function test( t ) { - var arr; - - arr = new Float32Matrix( new ArrayBuffer( 64 ), 8, [ 2, 1 ], { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 2, 1 ], 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning read-only ndarrays (arraybuffer, byteoffset, M, N)', function test( t ) { - var arr; - - arr = new Float32Matrix( new ArrayBuffer( 64 ), 8, 2, 1, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 2, 1 ], 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning writable ndarrays', function test( t ) { - var arr; - - arr = new Float32Matrix({ - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 0, 0 ], 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning writable ndarrays (shape)', function test( t ) { - var arr; - - arr = new Float32Matrix( [ 3, 3 ], { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 3, 3 ], 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning writable ndarrays (array)', function test( t ) { - var arr; - - arr = new Float32Matrix( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ], { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 2, 2 ], 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning writable ndarrays (arraybuffer)', function test( t ) { - var arr; - - arr = new Float32Matrix( new ArrayBuffer( 64 ), { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 1, 16 ], 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning writable ndarrays (arraybuffer, byteoffset)', function test( t ) { - var arr; - - arr = new Float32Matrix( new ArrayBuffer( 64 ), 8, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 1, 14 ], 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning writable ndarrays (arraybuffer, byteoffset, shape)', function test( t ) { - var arr; - - arr = new Float32Matrix( new ArrayBuffer( 64 ), 8, [ 2, 1 ], { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 2, 1 ], 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning writable ndarrays (arraybuffer, byteoffset, M, N)', function test( t ) { - var arr; - - arr = new Float32Matrix( new ArrayBuffer( 64 ), 8, 2, 1, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 2, 1 ], 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); From f1126bda663c5f3df788c46be7235f6f39f9b495 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 1 Jul 2026 03:29:38 +0000 Subject: [PATCH 06/11] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 0177c84..d6f3604 100644 --- a/package.json +++ b/package.json @@ -56,7 +56,7 @@ "@stdlib/ndarray-shape": "^0.2.3", "@stdlib/ndarray-to-array": "^0.2.2", "@stdlib/random-array-discrete-uniform": "^0.2.2", - "@stdlib/string-format": "^0.2.3", + "@stdlib/error-tools-fmtprodmsg": "^0.2.3", "tape": "git+https://github.com/kgryte/tape.git#fix/globby", "istanbul": "^0.4.1", "tap-min": "git+https://github.com/Planeshifter/tap-min.git", From 6139b0dd51ba1b6e0d740a8e01997dec0a1ed11f Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 1 Jul 2026 03:36:47 +0000 Subject: [PATCH 07/11] Remove files --- index.d.ts | 532 ------ index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5379 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 fb5eb97..0000000 --- a/index.d.ts +++ /dev/null @@ -1,532 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2026 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 - -/* eslint-disable @typescript-eslint/unified-signatures */ - -/// - -import { Order, Mode, float32ndarray, Shape2D } from '@stdlib/types/ndarray'; -import { Collection, AccessorArrayLike, ArrayLike } from '@stdlib/types/array'; -import ArrayBuffer = require( '@stdlib/array-buffer' ); - -/** -* Interface describing function options. -*/ -interface Options { - /** - * Array order (either 'row-major' (C-style) or 'column-major' (Fortran-style)). - */ - order?: Order; - - /** - * Specifies how to handle a linear index which exceeds array dimensions (default: 'throw'). - */ - mode?: Mode; - - /** - * Specifies how to handle subscripts which exceed array dimensions on a per dimension basis (default: ['throw']). - */ - submode?: ArrayLike; - - /** - * Boolean indicating whether an array should be read-only (default: false). - */ - readonly?: boolean; -} - -/** -* Interface defining a typed matrix constructor which is both "newable" and "callable". -*/ -interface Float32Matrix { - /** - * Creates a single-precision floating-point matrix (i.e., a two-dimensional ndarray). - * - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only matrix - * @param options.mode - specifies how to handle indices which exceed matrix dimensions - * @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis - * @param options.order - memory layout (either row-major or column-major) - * @returns two-dimensional ndarray - * - * @example - * var getShape = require( '@stdlib/ndarray-shape' ); - * - * var arr = new Float32Matrix(); - * // returns - * - * var sh = getShape( arr ); - * // returns [ 0, 0 ] - */ - new ( options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point matrix (i.e., a two-dimensional ndarray). - * - * @param shape - matrix shape - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only matrix - * @param options.mode - specifies how to handle indices which exceed matrix dimensions - * @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis - * @param options.order - memory layout (either row-major or column-major) - * @returns two-dimensional ndarray - * - * @example - * var getShape = require( '@stdlib/ndarray-shape' ); - * - * var arr = new Float32Matrix( [ 2, 2 ] ); - * // returns - * - * var sh = getShape( arr ); - * // returns [ 2, 2 ] - */ - new ( shape: Shape2D, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point matrix (i.e., a two-dimensional ndarray). - * - * @param M - number of rows - * @param N - number of columns - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only matrix - * @param options.mode - specifies how to handle indices which exceed matrix dimensions - * @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis - * @param options.order - memory layout (either row-major or column-major) - * @returns two-dimensional ndarray - * - * @example - * var getShape = require( '@stdlib/ndarray-shape' ); - * - * var arr = new Float32Matrix( 2, 2 ); - * // returns - * - * var sh = getShape( arr ); - * // returns [ 2, 2 ] - */ - new ( M: number, N: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point matrix (i.e., a two-dimensional ndarray). - * - * @param obj - array-like object or iterable from which to generate a matrix - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only matrix - * @param options.mode - specifies how to handle indices which exceed matrix dimensions - * @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis - * @param options.order - memory layout (either row-major or column-major) - * @returns two-dimensional ndarray - * - * @example - * var getShape = require( '@stdlib/ndarray-shape' ); - * - * var arr = new Float32Matrix( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ); - * // returns - * - * var sh = getShape( arr ); - * // returns [ 2, 2 ] - */ - new ( obj: ArrayLike | AccessorArrayLike> | Iterable | AccessorArrayLike>, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point matrix (i.e., a two-dimensional ndarray). - * - * ## Notes - * - * - The returned ndarray view spans the entirety of the underlying ArrayBuffer and the leading dimension of the returned ndarray always has a size of one. - * - * @param buffer - underlying ArrayBuffer - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only matrix - * @param options.mode - specifies how to handle indices which exceed matrix dimensions - * @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis - * @param options.order - memory layout (either row-major or column-major) - * @returns two-dimensional ndarray - * - * @example - * var getShape = require( '@stdlib/ndarray-shape' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Matrix( buf ); - * // returns - * - * var sh = getShape( arr ); - * // returns [ 1, 8 ] - */ - new ( buffer: ArrayBuffer, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point matrix (i.e., a two-dimensional ndarray). - * - * ## Notes - * - * - The returned ndarray view spans from the byteOffset to the end of the underlying ArrayBuffer and the leading dimension of the returned ndarray always has a size of one. - * - * @param buffer - underlying ArrayBuffer - * @param byteOffset - integer byte offset specifying the location of the first matrix element - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only matrix - * @param options.mode - specifies how to handle indices which exceed matrix dimensions - * @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis - * @param options.order - memory layout (either row-major or column-major) - * @returns two-dimensional ndarray - * - * @example - * var getShape = require( '@stdlib/ndarray-shape' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Matrix( buf, 8 ); - * // returns - * - * var sh = getShape( arr ); - * // returns [ 1, 6 ] - */ - new ( buffer: ArrayBuffer, byteOffset: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point matrix (i.e., a two-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param byteOffset - integer byte offset specifying the location of the first matrix element - * @param shape - matrix shape - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only matrix - * @param options.mode - specifies how to handle indices which exceed matrix dimensions - * @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis - * @param options.order - memory layout (either row-major or column-major) - * @returns two-dimensional ndarray - * - * @example - * var getShape = require( '@stdlib/ndarray-shape' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Matrix( buf, 8, [ 2, 1 ] ); - * // returns - * - * var sh = getShape( arr ); - * // returns [ 2, 1 ] - */ - new ( buffer: ArrayBuffer, byteOffset: number, shape: Shape2D, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point matrix (i.e., a two-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param byteOffset - integer byte offset specifying the location of the first matrix element - * @param M - number of rows - * @param N - number of columns - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only matrix - * @param options.mode - specifies how to handle indices which exceed matrix dimensions - * @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis - * @param options.order - memory layout (either row-major or column-major) - * @returns two-dimensional ndarray - * - * @example - * var getShape = require( '@stdlib/ndarray-shape' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Matrix( buf, 8, 2, 1 ); - * // returns - * - * var sh = getShape( arr ); - * // returns [ 2, 1 ] - */ - new ( buffer: ArrayBuffer, byteOffset: number, M: number, N: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point matrix (i.e., a two-dimensional ndarray). - * - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only matrix - * @param options.mode - specifies how to handle indices which exceed matrix dimensions - * @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis - * @param options.order - memory layout (either row-major or column-major) - * @returns two-dimensional ndarray - * - * @example - * var getShape = require( '@stdlib/ndarray-shape' ); - * - * var arr = new Float32Matrix(); - * // returns - * - * var sh = getShape( arr ); - * // returns [ 0, 0 ] - */ - ( options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point matrix (i.e., a two-dimensional ndarray). - * - * @param shape - matrix shape - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only matrix - * @param options.mode - specifies how to handle indices which exceed matrix dimensions - * @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis - * @param options.order - memory layout (either row-major or column-major) - * @returns two-dimensional ndarray - * - * @example - * var getShape = require( '@stdlib/ndarray-shape' ); - * - * var arr = new Float32Matrix( [ 2, 2 ] ); - * // returns - * - * var sh = getShape( arr ); - * // returns [ 2, 2 ] - */ - ( shape: Shape2D, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point matrix (i.e., a two-dimensional ndarray). - * - * @param M - number of rows - * @param N - number of columns - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only matrix - * @param options.mode - specifies how to handle indices which exceed matrix dimensions - * @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis - * @param options.order - memory layout (either row-major or column-major) - * @returns two-dimensional ndarray - * - * @example - * var getShape = require( '@stdlib/ndarray-shape' ); - * - * var arr = new Float32Matrix( 2, 2 ); - * // returns - * - * var sh = getShape( arr ); - * // returns [ 2, 2 ] - */ - ( M: number, N: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point matrix (i.e., a two-dimensional ndarray). - * - * @param obj - array-like object or iterable from which to generate a matrix - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only matrix - * @param options.mode - specifies how to handle indices which exceed matrix dimensions - * @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis - * @param options.order - memory layout (either row-major or column-major) - * @returns two-dimensional ndarray - * - * @example - * var getShape = require( '@stdlib/ndarray-shape' ); - * - * var arr = new Float32Matrix( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ); - * // returns - * - * var sh = getShape( arr ); - * // returns [ 2, 2 ] - */ - ( obj: ArrayLike | AccessorArrayLike> | Iterable | AccessorArrayLike>, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point matrix (i.e., a two-dimensional ndarray). - * - * ## Notes - * - * - The returned ndarray view spans the entirety of the underlying ArrayBuffer and the leading dimension of the returned ndarray always has a size of one. - * - * @param buffer - underlying ArrayBuffer - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only matrix - * @param options.mode - specifies how to handle indices which exceed matrix dimensions - * @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis - * @param options.order - memory layout (either row-major or column-major) - * @returns two-dimensional ndarray - * - * @example - * var getShape = require( '@stdlib/ndarray-shape' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Matrix( buf ); - * // returns - * - * var sh = getShape( arr ); - * // returns [ 1, 8 ] - */ - ( buffer: ArrayBuffer, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point matrix (i.e., a two-dimensional ndarray). - * - * ## Notes - * - * - The returned ndarray view spans from the byteOffset to the end of the underlying ArrayBuffer and the leading dimension of the returned ndarray always has a size of one. - * - * @param buffer - underlying ArrayBuffer - * @param byteOffset - integer byte offset specifying the location of the first matrix element - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only matrix - * @param options.mode - specifies how to handle indices which exceed matrix dimensions - * @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis - * @param options.order - memory layout (either row-major or column-major) - * @returns two-dimensional ndarray - * - * @example - * var getShape = require( '@stdlib/ndarray-shape' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Matrix( buf, 8 ); - * // returns - * - * var sh = getShape( arr ); - * // returns [ 1, 6 ] - */ - ( buffer: ArrayBuffer, byteOffset: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point matrix (i.e., a two-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param byteOffset - integer byte offset specifying the location of the first matrix element - * @param shape - matrix shape - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only matrix - * @param options.mode - specifies how to handle indices which exceed matrix dimensions - * @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis - * @param options.order - memory layout (either row-major or column-major) - * @returns two-dimensional ndarray - * - * @example - * var getShape = require( '@stdlib/ndarray-shape' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Matrix( buf, 8, [ 2, 1 ] ); - * // returns - * - * var sh = getShape( arr ); - * // returns [ 2, 1 ] - */ - ( buffer: ArrayBuffer, byteOffset: number, shape: Shape2D, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point matrix (i.e., a two-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param byteOffset - integer byte offset specifying the location of the first matrix element - * @param M - number of rows - * @param N - number of columns - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only matrix - * @param options.mode - specifies how to handle indices which exceed matrix dimensions - * @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis - * @param options.order - memory layout (either row-major or column-major) - * @returns two-dimensional ndarray - * - * @example - * var getShape = require( '@stdlib/ndarray-shape' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Matrix( buf, 8, 2, 1 ); - * // returns - * - * var sh = getShape( arr ); - * // returns [ 2, 1 ] - */ - ( buffer: ArrayBuffer, byteOffset: number, M: number, N: number, options?: Options ): float32ndarray; -} - -/** -* Creates a single-precision floating-point matrix (i.e., a two-dimensional ndarray). -* -* @param arg0 - shape, number of rows, array-like object, ArrayBuffer, or iterable -* @param arg1 - number of columns or integer byte offset specifying the location of the first matrix element -* @param arg2 - matrix shape or number of rows -* @param arg3 - number of columns -* @param options - function options -* @param options.readonly - boolean indicating whether to return a read-only matrix -* @param options.mode - specifies how to handle indices which exceed matrix dimensions -* @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis -* @param options.order - memory layout (either row-major or column-major) -* @returns two-dimensional ndarray -* -* @example -* var getShape = require( '@stdlib/ndarray-shape' ); -* -* var arr = new Float32Matrix(); -* // returns -* -* var sh = getShape( arr ); -* // returns [ 0, 0 ] -* -* @example -* var getShape = require( '@stdlib/ndarray-shape' ); -* -* var arr = new Float32Matrix( [ 2, 2 ] ); -* // returns -* -* var sh = getShape( arr ); -* // returns [ 2, 2 ] -* -* @example -* var getShape = require( '@stdlib/ndarray-shape' ); -* -* var arr = new Float32Matrix( 2, 2 ); -* // returns -* -* var sh = getShape( arr ); -* // returns [ 2, 2 ] -* -* @example -* var getShape = require( '@stdlib/ndarray-shape' ); -* -* var arr = new Float32Matrix( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ); -* // returns -* -* var sh = getShape( arr ); -* // returns [ 2, 2 ] -* -* @example -* var getShape = require( '@stdlib/ndarray-shape' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 32 ); -* var arr = new Float32Matrix( buf, 8, [ 2, 1 ] ); -* // returns -* -* var sh = getShape( arr ); -* // returns [ 2, 1 ] -* -* @example -* var getShape = require( '@stdlib/ndarray-shape' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 32 ); -* var arr = new Float32Matrix( buf, 8, 2, 1 ); -* // returns -* -* var sh = getShape( arr ); -* // returns [ 2, 1 ] -*/ -declare var ctor: Float32Matrix; - - -// EXPORTS // - -export = ctor; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index d687205..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import{factory as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-matrix-ctor@esm/index.mjs";var r=t("float32");export{r as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 1fc582f..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2026 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* 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 as factory } from '@stdlib/ndarray-matrix-ctor';\n\n\n// MAIN //\n\n/**\n* Returns a single-precision floating-point matrix (i.e., a two-dimensional ndarray).\n*\n* @name Float32Matrix\n* @type {Function}\n* @param {(NonNegativeInteger|NonNegativeIntegerArray|ArrayLikeObject|ArrayBuffer|Iterable)} [arg0] - shape, number of rows, array-like object, ArrayBuffer, or iterable\n* @param {NonNegativeInteger} [arg1] - number of columns or byte offset\n* @param {(NonNegativeInteger|NonNegativeIntegerArray)} [arg2] - shape or number of rows\n* @param {NonNegativeInteger} [arg3] - number of columns\n* @param {Options} [options] - function options\n* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only matrix\n* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed matrix dimensions\n* @param {StringArray} [options.submode=[options.mode]] - specifies how to handle subscripts which exceed array dimensions on a per dimension basis\n* @param {string} [options.order='row-major'] - memory layout (either row-major or column-major)\n* @throws {TypeError} first argument must be either a shape, integer, array-like object, ArrayBuffer, iterable, or options object\n* @throws {TypeError} must provide valid options\n* @returns {ndarray} two-dimensional ndarray\n*\n* @example\n* import getShape from '@stdlib/ndarray-shape';\n*\n* var v = new Float32Matrix();\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 0, 0 ]\n*\n* @example\n* import getShape from '@stdlib/ndarray-shape';\n*\n* var v = new Float32Matrix( [ 2, 2 ] );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 2 ]\n*\n* @example\n* import getShape from '@stdlib/ndarray-shape';\n*\n* var v = new Float32Matrix( 2, 2 );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 2 ]\n*\n* @example\n* import getShape from '@stdlib/ndarray-shape';\n*\n* var v = new Float32Matrix( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 2 ]\n*\n* @example\n* import ArrayBuffer from '@stdlib/array-buffer';\n* import getShape from '@stdlib/ndarray-shape';\n*\n* var buf = new ArrayBuffer( 32 );\n* var v = new Float32Matrix( buf );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 1, 8 ]\n*\n* @example\n* import ArrayBuffer from '@stdlib/array-buffer';\n* import getShape from '@stdlib/ndarray-shape';\n*\n* var buf = new ArrayBuffer( 32 );\n* var v = new Float32Matrix( buf, 16 );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 1, 4 ]\n*\n* @example\n* import ArrayBuffer from '@stdlib/array-buffer';\n* import getShape from '@stdlib/ndarray-shape';\n*\n* var buf = new ArrayBuffer( 64 );\n* var v = new Float32Matrix( buf, 16, [ 2, 1 ] );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 1 ]\n*\n* @example\n* import ArrayBuffer from '@stdlib/array-buffer';\n* import getShape from '@stdlib/ndarray-shape';\n*\n* var buf = new ArrayBuffer( 64 );\n* var v = new Float32Matrix( buf, 16, 2, 1 );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 1 ]\n*/\nvar Float32Matrix = factory( 'float32' );\n\n\n// EXPORTS //\n\nexport default Float32Matrix;\n"],"names":["Float32Matrix","factory"],"mappings":";;kGA6HG,IAACA,EAAgBC,EAAS"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 0807e84..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 5ea97418edede618e4c0122d5a7abbb135eb1ee4 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 1 Jul 2026 03:37:20 +0000 Subject: [PATCH 08/11] Auto-generated commit --- .editorconfig | 189 - .eslintrc.js | 1 - .gitattributes | 68 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 821 --- .github/workflows/publish.yml | 261 - .github/workflows/test.yml | 101 - .github/workflows/test_bundles.yml | 213 - .github/workflows/test_coverage.yml | 142 - .github/workflows/test_install.yml | 94 - .github/workflows/test_published_package.yml | 115 - .gitignore | 204 - .npmignore | 229 - .npmrc | 44 - CHANGELOG.md | 51 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 63 +- SECURITY.md | 5 - benchmark/benchmark.js | 47 - benchmark/benchmark.size.js | 95 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 361 -- docs/types/test.ts | 100 - examples/index.js | 51 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 122 - lib/main.js | 131 - package.json | 68 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 1394 ----- 45 files changed, 4877 insertions(+), 5975 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.js delete mode 100644 benchmark/benchmark.size.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 (99%) create mode 100644 index.mjs create mode 100644 index.mjs.map 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.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 80f3fca..0000000 --- a/.editorconfig +++ /dev/null @@ -1,189 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim. - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Ignore generated lock files for GitHub Agentic Workflows: -[*.lock.yml] -charset = unset -end_of_line = unset -indent_style = unset -indent_size = unset -trim_trailing_whitespace = unset -insert_final_newline = unset - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 24b327f..0000000 --- a/.gitattributes +++ /dev/null @@ -1,68 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation - -.github/workflows/*.lock.yml linguist-generated=true merge=ours diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 43b890e..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2026-07-01T03:27:20.500Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 13e3774..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/ndarray/matrix/float32) 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 6686a6b..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/ndarray/matrix/float32) 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 bfaf214..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: '2 2 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 83d50c4..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,821 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send notification to Zulip if job fails: - - name: 'Send notification to Zulip in case of failure' - # Pin action to full length commit SHA - uses: zulip/github-actions-zulip/send-message@e4c8f27c732ba9bd98ac6be0583096dea82feea5 # v1.0.2 - if: failure() - with: - api-key: ${{ secrets.ZULIP_API_KEY }} - email: 'github-actions-bot@stdlib.zulipchat.com' - organization-url: 'https://stdlib.zulipchat.com' - to: 'workflows-standalone' - type: 'stream' - topic: ${{ github.event.repository.name }} - content: | - :cross_mark: **${{ github.workflow }}** workflow failed - - **Repository:** [${{ github.repository }}](${{ github.server_url }}/${{ github.repository }}) - **Run:** [View workflow run](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}) - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -301,7 +292,7 @@ console.log( ndarray2array( v ) ); ## 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]. @@ -364,9 +355,9 @@ Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-matrix-float32/main/LICENSE -[@stdlib/array/buffer]: https://github.com/stdlib-js/array-buffer +[@stdlib/array/buffer]: https://github.com/stdlib-js/array-buffer/tree/esm -[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor +[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor/tree/esm
diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 03b1296..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,47 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2026 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var pkg = require( './../package.json' ).name; -var Float32Matrix = require( './../lib' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var arr; - var i; - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr = new Float32Matrix( 0, 0 ); - if ( arr.length !== 0 ) { - b.fail( 'should have length 0' ); - } - } - b.toc(); - if ( !isndarrayLike( arr ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.size.js b/benchmark/benchmark.size.js deleted file mode 100644 index 664d979..0000000 --- a/benchmark/benchmark.size.js +++ /dev/null @@ -1,95 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2026 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var Float32Matrix = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveIntegerArray} shape - array shape -* @returns {Function} benchmark function -*/ -function createBenchmark( shape ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var arr; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr = new Float32Matrix( shape ); - if ( typeof arr !== 'object' ) { - b.fail( 'should return an ndarray' ); - } - } - b.toc(); - if ( !isndarrayLike( arr ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var N; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - N = floor( pow( pow( 10, i ), 1.0/2.0 ) ); - f = createBenchmark( [ N, N ] ); - bench( format( '%s::equidimensional:size=%d', pkg, N*N ), f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 7b916fa..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/ndarray/matrix/float32" -%% click B href "https://github.com/stdlib-js/ndarray-matrix-float32/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-matrix-float32/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-matrix-float32/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-matrix-float32/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-matrix-float32/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/matrix/float32 -[production-url]: https://github.com/stdlib-js/ndarray-matrix-float32/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-matrix-float32/tree/deno -[deno-readme]: https://github.com/stdlib-js/ndarray-matrix-float32/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/ndarray-matrix-float32/tree/umd -[umd-readme]: https://github.com/stdlib-js/ndarray-matrix-float32/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/ndarray-matrix-float32/tree/esm -[esm-readme]: https://github.com/stdlib-js/ndarray-matrix-float32/blob/esm/README.md \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index 0b44231..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import ctor from '../docs/types/index'; -export = ctor; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 26cde3c..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var o=function(e,r){return function(){try{return r||e((r={exports:{}}).exports,r),r.exports}catch(i){throw (r=0, i)}};};var a=o(function(v,t){ -var s=require('@stdlib/ndarray-matrix-ctor/dist').factory,c=s("float32");t.exports=c -});var u=a();module.exports=u; -/** @license Apache-2.0 */ -//# sourceMappingURL=index.js.map diff --git a/dist/index.js.map b/dist/index.js.map deleted file mode 100644 index a628c0a..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/main.js", "../lib/index.js"], - "sourcesContent": ["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2026 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* 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( '@stdlib/ndarray-matrix-ctor' ).factory;\n\n\n// MAIN //\n\n/**\n* Returns a single-precision floating-point matrix (i.e., a two-dimensional ndarray).\n*\n* @name Float32Matrix\n* @type {Function}\n* @param {(NonNegativeInteger|NonNegativeIntegerArray|ArrayLikeObject|ArrayBuffer|Iterable)} [arg0] - shape, number of rows, array-like object, ArrayBuffer, or iterable\n* @param {NonNegativeInteger} [arg1] - number of columns or byte offset\n* @param {(NonNegativeInteger|NonNegativeIntegerArray)} [arg2] - shape or number of rows\n* @param {NonNegativeInteger} [arg3] - number of columns\n* @param {Options} [options] - function options\n* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only matrix\n* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed matrix dimensions\n* @param {StringArray} [options.submode=[options.mode]] - specifies how to handle subscripts which exceed array dimensions on a per dimension basis\n* @param {string} [options.order='row-major'] - memory layout (either row-major or column-major)\n* @throws {TypeError} first argument must be either a shape, integer, array-like object, ArrayBuffer, iterable, or options object\n* @throws {TypeError} must provide valid options\n* @returns {ndarray} two-dimensional ndarray\n*\n* @example\n* var getShape = require( '@stdlib/ndarray-shape' );\n*\n* var v = new Float32Matrix();\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 0, 0 ]\n*\n* @example\n* var getShape = require( '@stdlib/ndarray-shape' );\n*\n* var v = new Float32Matrix( [ 2, 2 ] );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 2 ]\n*\n* @example\n* var getShape = require( '@stdlib/ndarray-shape' );\n*\n* var v = new Float32Matrix( 2, 2 );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 2 ]\n*\n* @example\n* var getShape = require( '@stdlib/ndarray-shape' );\n*\n* var v = new Float32Matrix( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 2 ]\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var getShape = require( '@stdlib/ndarray-shape' );\n*\n* var buf = new ArrayBuffer( 32 );\n* var v = new Float32Matrix( buf );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 1, 8 ]\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var getShape = require( '@stdlib/ndarray-shape' );\n*\n* var buf = new ArrayBuffer( 32 );\n* var v = new Float32Matrix( buf, 16 );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 1, 4 ]\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var getShape = require( '@stdlib/ndarray-shape' );\n*\n* var buf = new ArrayBuffer( 64 );\n* var v = new Float32Matrix( buf, 16, [ 2, 1 ] );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 1 ]\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var getShape = require( '@stdlib/ndarray-shape' );\n*\n* var buf = new ArrayBuffer( 64 );\n* var v = new Float32Matrix( buf, 16, 2, 1 );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 1 ]\n*/\nvar Float32Matrix = factory( 'float32' );\n\n\n// EXPORTS //\n\nmodule.exports = Float32Matrix;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2026 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 a single-precision floating-point matrix (i.e., a two-dimensional ndarray).\n*\n* @module @stdlib/ndarray-matrix-float32\n*\n* @example\n* var getShape = require( '@stdlib/ndarray-shape' );\n* var Float32Matrix = require( '@stdlib/ndarray-matrix-float32' );\n*\n* var v = new Float32Matrix();\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 0, 0 ]\n*\n* @example\n* var getShape = require( '@stdlib/ndarray-shape' );\n* var Float32Matrix = require( '@stdlib/ndarray-matrix-float32' );\n*\n* var v = new Float32Matrix( [ 2, 2 ] );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 2 ]\n*\n* @example\n* var getShape = require( '@stdlib/ndarray-shape' );\n* var Float32Matrix = require( '@stdlib/ndarray-matrix-float32' );\n*\n* var v = new Float32Matrix( 2, 2 );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 2 ]\n*\n* @example\n* var getShape = require( '@stdlib/ndarray-shape' );\n* var Float32Matrix = require( '@stdlib/ndarray-matrix-float32' );\n*\n* var v = new Float32Matrix( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 2 ]\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var getShape = require( '@stdlib/ndarray-shape' );\n* var Float32Matrix = require( '@stdlib/ndarray-matrix-float32' );\n*\n* var buf = new ArrayBuffer( 32 );\n* var v = new Float32Matrix( buf );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 1, 8 ]\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var getShape = require( '@stdlib/ndarray-shape' );\n* var Float32Matrix = require( '@stdlib/ndarray-matrix-float32' );\n*\n* var buf = new ArrayBuffer( 32 );\n* var v = new Float32Matrix( buf, 16 );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 1, 4 ]\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var getShape = require( '@stdlib/ndarray-shape' );\n* var Float32Matrix = require( '@stdlib/ndarray-matrix-float32' );\n*\n* var buf = new ArrayBuffer( 64 );\n* var v = new Float32Matrix( buf, 16, [ 2, 1 ] );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 1 ]\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var getShape = require( '@stdlib/ndarray-shape' );\n* var Float32Matrix = require( '@stdlib/ndarray-matrix-float32' );\n*\n* var buf = new ArrayBuffer( 64 );\n* var v = new Float32Matrix( buf, 16, 2, 1 );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 1 ]\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "iIAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,QAAS,6BAA8B,EAAE,QAuGnDC,EAAgBD,EAAS,SAAU,EAKvCD,EAAO,QAAUE,ICdjB,IAAIC,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "factory", "Float32Matrix", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index b0bbaa9..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,361 +0,0 @@ - -{{alias}}( [options] ) - Returns a two-dimensional single-precision floating-point ndarray. - - Parameters - ---------- - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran-style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle indices which exceed array dimensions. If equal - to 'throw', an ndarray instance throws an error when an index exceeds - array dimensions. If equal to 'normalize', an ndarray instance - normalizes negative indices and throws an error when an index exceeds - array dimensions. If equal to 'wrap', an ndarray instance wraps around - indices exceeding array dimensions using modulo arithmetic. If equal to - 'clamp', an ndarray instance sets an index exceeding array dimensions - to either `0` (minimum index) or the maximum index. Default: 'throw'. - - options.submode: Array (optional) - Specifies how to handle subscripts which exceed array dimensions. If a - mode for a corresponding dimension is equal to 'throw', an ndarray - instance throws an error when a subscript exceeds array dimensions. If - equal to 'normalize', an ndarray instance normalizes negative - subscripts and throws an error when a subscript exceeds array - dimensions. If equal to 'wrap', an ndarray instance wraps around - subscripts exceeding array dimensions using modulo arithmetic. If equal - to 'clamp', an ndarray instance sets a subscript exceeding array - dimensions to either `0` (minimum index) or the maximum index. If the - number of modes is less than the number of dimensions, an ndarray - instance recycles modes using modulo arithmetic. - - Default: [ options.mode ]. - - options.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A two-dimensional ndarray. - - Examples - -------- - > var arr = {{alias}}() - - - -{{alias}}( shape[, options] ) - Returns a two-dimensional single-precision floating-point ndarray having a - specified shape. - - Parameters - ---------- - shape: ArrayLikeObject - Array shape. Must contain exactly two elements. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran-style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle indices which exceed array dimensions. If equal - to 'throw', an ndarray instance throws an error when an index exceeds - array dimensions. If equal to 'normalize', an ndarray instance - normalizes negative indices and throws an error when an index exceeds - array dimensions. If equal to 'wrap', an ndarray instance wraps around - indices exceeding array dimensions using modulo arithmetic. If equal to - 'clamp', an ndarray instance sets an index exceeding array dimensions - to either `0` (minimum index) or the maximum index. Default: 'throw'. - - options.submode: Array (optional) - Specifies how to handle subscripts which exceed array dimensions. If a - mode for a corresponding dimension is equal to 'throw', an ndarray - instance throws an error when a subscript exceeds array dimensions. If - equal to 'normalize', an ndarray instance normalizes negative - subscripts and throws an error when a subscript exceeds array - dimensions. If equal to 'wrap', an ndarray instance wraps around - subscripts exceeding array dimensions using modulo arithmetic. If equal - to 'clamp', an ndarray instance sets a subscript exceeding array - dimensions to either `0` (minimum index) or the maximum index. If the - number of modes is less than the number of dimensions, an ndarray - instance recycles modes using modulo arithmetic. - - Default: [ options.mode ]. - - options.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A two-dimensional ndarray. - - Examples - -------- - > var arr = {{alias}}( [ 2, 2 ] ) - - - -{{alias}}( M, N[, options] ) - Returns a two-dimensional single-precision floating-point ndarray having a - specified shape. - - Parameters - ---------- - M: integer - Number of rows. - - N: integer - Number of columns. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran-style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle indices which exceed array dimensions. If equal - to 'throw', an ndarray instance throws an error when an index exceeds - array dimensions. If equal to 'normalize', an ndarray instance - normalizes negative indices and throws an error when an index exceeds - array dimensions. If equal to 'wrap', an ndarray instance wraps around - indices exceeding array dimensions using modulo arithmetic. If equal to - 'clamp', an ndarray instance sets an index exceeding array dimensions - to either `0` (minimum index) or the maximum index. Default: 'throw'. - - options.submode: Array (optional) - Specifies how to handle subscripts which exceed array dimensions. If a - mode for a corresponding dimension is equal to 'throw', an ndarray - instance throws an error when a subscript exceeds array dimensions. If - equal to 'normalize', an ndarray instance normalizes negative - subscripts and throws an error when a subscript exceeds array - dimensions. If equal to 'wrap', an ndarray instance wraps around - subscripts exceeding array dimensions using modulo arithmetic. If equal - to 'clamp', an ndarray instance sets a subscript exceeding array - dimensions to either `0` (minimum index) or the maximum index. If the - number of modes is less than the number of dimensions, an ndarray - instance recycles modes using modulo arithmetic. - - Default: [ options.mode ]. - - options.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A two-dimensional ndarray. - - Examples - -------- - > var arr = {{alias}}( 2, 2 ) - - - -{{alias}}( obj[, options] ) - Creates a two-dimensional single-precision floating-point ndarray from an - array-like object or iterable. - - Parameters - ---------- - obj: Object - Array-like object or iterable from which to generate an ndarray. If an - array-like object, the value must be a nested array (i.e., an array-like - object of array-like objects), where each nested array must have the - same number of elements. If an iterable, the iterable must return array- - like objects, each of which must have the same number of elements. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran-style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle indices which exceed array dimensions. If equal - to 'throw', an ndarray instance throws an error when an index exceeds - array dimensions. If equal to 'normalize', an ndarray instance - normalizes negative indices and throws an error when an index exceeds - array dimensions. If equal to 'wrap', an ndarray instance wraps around - indices exceeding array dimensions using modulo arithmetic. If equal to - 'clamp', an ndarray instance sets an index exceeding array dimensions - to either `0` (minimum index) or the maximum index. Default: 'throw'. - - options.submode: Array (optional) - Specifies how to handle subscripts which exceed array dimensions. If a - mode for a corresponding dimension is equal to 'throw', an ndarray - instance throws an error when a subscript exceeds array dimensions. If - equal to 'normalize', an ndarray instance normalizes negative - subscripts and throws an error when a subscript exceeds array - dimensions. If equal to 'wrap', an ndarray instance wraps around - subscripts exceeding array dimensions using modulo arithmetic. If equal - to 'clamp', an ndarray instance sets a subscript exceeding array - dimensions to either `0` (minimum index) or the maximum index. If the - number of modes is less than the number of dimensions, an ndarray - instance recycles modes using modulo arithmetic. - - Default: [ options.mode ]. - - options.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A two-dimensional ndarray. - - Examples - -------- - > var v = [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]; - > var arr = {{alias}}( v ) - - - -{{alias}}( buffer[, byteOffset[, shape]][, options] ) - Returns a two-dimensional single-precision floating-point ndarray view of an - ArrayBuffer. - - Parameters - ---------- - buffer: ArrayBuffer - Underlying ArrayBuffer. - - byteOffset: integer (optional) - Integer byte offset specifying the location of the first indexed - element. Default: 0. - - shape: ArrayLikeObject (optional) - Array shape. Must contain exactly two elements. If not provided, the - view spans from the byteOffset to the end of the underlying ArrayBuffer - and the first dimension of the returned ndarray has a size of one. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran-style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle indices which exceed array dimensions. If equal - to 'throw', an ndarray instance throws an error when an index exceeds - array dimensions. If equal to 'normalize', an ndarray instance - normalizes negative indices and throws an error when an index exceeds - array dimensions. If equal to 'wrap', an ndarray instance wraps around - indices exceeding array dimensions using modulo arithmetic. If equal to - 'clamp', an ndarray instance sets an index exceeding array dimensions - to either `0` (minimum index) or the maximum index. Default: 'throw'. - - options.submode: Array (optional) - Specifies how to handle subscripts which exceed array dimensions. If a - mode for a corresponding dimension is equal to 'throw', an ndarray - instance throws an error when a subscript exceeds array dimensions. If - equal to 'normalize', an ndarray instance normalizes negative - subscripts and throws an error when a subscript exceeds array - dimensions. If equal to 'wrap', an ndarray instance wraps around - subscripts exceeding array dimensions using modulo arithmetic. If equal - to 'clamp', an ndarray instance sets a subscript exceeding array - dimensions to either `0` (minimum index) or the maximum index. If the - number of modes is less than the number of dimensions, an ndarray - instance recycles modes using modulo arithmetic. - - Default: [ options.mode ]. - - options.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A two-dimensional ndarray. - - Examples - -------- - > var buf = new {{alias:@stdlib/array/buffer}}( 32 ); - > var arr = {{alias}}( buf, 0, [ 8, 1 ] ) - - - -{{alias}}( buffer[, byteOffset[, M, N]][, options] ) - Returns a two-dimensional single-precision floating-point ndarray view of an - ArrayBuffer. - - If `M` and `N` are not provided, the returned ndarray view spans from the - byteOffset to the end of the underlying ArrayBuffer. - - Parameters - ---------- - buffer: ArrayBuffer - Underlying ArrayBuffer. - - byteOffset: integer (optional) - Integer byte offset specifying the location of the first indexed - element. Default: 0. - - M: integer (optional) - Number of rows. - - N: integer (optional) - Number of columns. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran-style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle indices which exceed array dimensions. If equal - to 'throw', an ndarray instance throws an error when an index exceeds - array dimensions. If equal to 'normalize', an ndarray instance - normalizes negative indices and throws an error when an index exceeds - array dimensions. If equal to 'wrap', an ndarray instance wraps around - indices exceeding array dimensions using modulo arithmetic. If equal to - 'clamp', an ndarray instance sets an index exceeding array dimensions - to either `0` (minimum index) or the maximum index. Default: 'throw'. - - options.submode: Array (optional) - Specifies how to handle subscripts which exceed array dimensions. If a - mode for a corresponding dimension is equal to 'throw', an ndarray - instance throws an error when a subscript exceeds array dimensions. If - equal to 'normalize', an ndarray instance normalizes negative - subscripts and throws an error when a subscript exceeds array - dimensions. If equal to 'wrap', an ndarray instance wraps around - subscripts exceeding array dimensions using modulo arithmetic. If equal - to 'clamp', an ndarray instance sets a subscript exceeding array - dimensions to either `0` (minimum index) or the maximum index. If the - number of modes is less than the number of dimensions, an ndarray - instance recycles modes using modulo arithmetic. - - Default: [ options.mode ]. - - options.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A two-dimensional ndarray. - - Examples - -------- - > var buf = new {{alias:@stdlib/array/buffer}}( 32 ); - > var arr = {{alias}}( buf, 0, 4, 1 ) - - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 0e6cc3d..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,100 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2026 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 ArrayBuffer = require( '@stdlib/array-buffer' ); -import Float32Matrix = require( './index' ); - - -// TESTS // - -// The function returns an ndarray... -{ - new Float32Matrix(); // $ExpectType float32ndarray - new Float32Matrix( {} ); // $ExpectType float32ndarray - - new Float32Matrix( 10, 10 ); // $ExpectType float32ndarray - new Float32Matrix( 10, 10, {} ); // $ExpectType float32ndarray - - new Float32Matrix( [ 10, 10 ] ); // $ExpectType float32ndarray - new Float32Matrix( [ 10, 10 ], {} ); // $ExpectType float32ndarray - - new Float32Matrix( [ [ 1, 2 ], [ 3, 4 ] ] ); // $ExpectType float32ndarray - new Float32Matrix( [ [ 1, 2 ], [ 3, 4 ] ], {} ); // $ExpectType float32ndarray - - new Float32Matrix( new ArrayBuffer( 10 ) ); // $ExpectType float32ndarray - new Float32Matrix( new ArrayBuffer( 10 ), {} ); // $ExpectType float32ndarray - - new Float32Matrix( new ArrayBuffer( 10 ), 8 ); // $ExpectType float32ndarray - new Float32Matrix( new ArrayBuffer( 10 ), 8, {} ); // $ExpectType float32ndarray - - new Float32Matrix( new ArrayBuffer( 10 ), 8, [ 1, 1 ] ); // $ExpectType float32ndarray - new Float32Matrix( new ArrayBuffer( 10 ), 8, [ 1, 1 ], {} ); // $ExpectType float32ndarray - - new Float32Matrix( new ArrayBuffer( 10 ), 8, 1, 1 ); // $ExpectType float32ndarray - new Float32Matrix( new ArrayBuffer( 10 ), 8, 1, 1, {} ); // $ExpectType float32ndarray - - const matrix = Float32Matrix; - matrix(); // $ExpectType float32ndarray - matrix( {} ); // $ExpectType float32ndarray - - matrix( 10, 10 ); // $ExpectType float32ndarray - matrix( 10, 10, {} ); // $ExpectType float32ndarray - - matrix( [ 10, 10 ] ); // $ExpectType float32ndarray - matrix( [ 10, 10 ], {} ); // $ExpectType float32ndarray - - matrix( [ [ 1, 2 ], [ 3, 4 ] ] ); // $ExpectType float32ndarray - matrix( [ [ 1, 2 ], [ 3, 4 ] ], {} ); // $ExpectType float32ndarray - - matrix( new ArrayBuffer( 10 ) ); // $ExpectType float32ndarray - matrix( new ArrayBuffer( 10 ), {} ); // $ExpectType float32ndarray - - matrix( new ArrayBuffer( 10 ), 8 ); // $ExpectType float32ndarray - matrix( new ArrayBuffer( 10 ), 8, {} ); // $ExpectType float32ndarray - - matrix( new ArrayBuffer( 10 ), 8, [ 1, 1 ] ); // $ExpectType float32ndarray - matrix( new ArrayBuffer( 10 ), 8, [ 1, 1 ], {} ); // $ExpectType float32ndarray - - matrix( new ArrayBuffer( 10 ), 8, 1, 1 ); // $ExpectType float32ndarray - matrix( new ArrayBuffer( 10 ), 8, 1, 1, {} ); // $ExpectType float32ndarray -} - -// The compiler throws an error if the function is provided a first argument which is not a number, array-like object, iterable, or options object... -{ - new Float32Matrix( true ); // $ExpectError - new Float32Matrix( false ); // $ExpectError - new Float32Matrix( null ); // $ExpectError - new Float32Matrix( ( x: number ): number => x ); // $ExpectError - - const matrix = Float32Matrix; - matrix( true ); // $ExpectError - matrix( false ); // $ExpectError - matrix( null ); // $ExpectError - matrix( ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const buf = new ArrayBuffer( 32 ); - new Float32Matrix( buf, 8, 2, 1, {}, {} ); // $ExpectError - new Float32Matrix( buf, 8, [ 2, 1 ], {}, {} ); // $ExpectError - - const matrix = Float32Matrix; - matrix( buf, 8, 2, 1, {}, {} ); // $ExpectError - matrix( buf, 8, [ 2, 1 ], {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index ca82258..0000000 --- a/examples/index.js +++ /dev/null @@ -1,51 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2026 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); -var sum = require( '@stdlib/blas-ext-sum' ); -var map = require( '@stdlib/ndarray-map' ); -var ndarray2array = require( '@stdlib/ndarray-to-array' ); -var Float32Matrix = require( './../lib' ); - -// Create a matrix containing random values: -var x = new Float32Matrix([ - discreteUniform( 10, 0, 100 ), - discreteUniform( 10, 0, 20 ) -]); - -// Compute the sum along the columns: -var v = sum( x, { - 'dims': [ -1 ] -}); -console.log( ndarray2array( v ) ); - -// Define a function which applies a threshold to individual values: -function threshold( v ) { - return ( v > 10 ) ? v : 0; -} - -// Apply threshold: -var y = map( x, threshold ); - -// Recompute the sum along the columns: -v = sum( y, { - 'dims': [ -1 ] -}); -console.log( ndarray2array( v ) ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 99% rename from docs/types/index.d.ts rename to index.d.ts index 5d30fac..fb5eb97 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -20,7 +20,7 @@ /* eslint-disable @typescript-eslint/unified-signatures */ -/// +/// import { Order, Mode, float32ndarray, Shape2D } from '@stdlib/types/ndarray'; import { Collection, AccessorArrayLike, ArrayLike } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..d687205 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import{factory as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-matrix-ctor@esm/index.mjs";var r=t("float32");export{r as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..1fc582f --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2026 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* 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 as factory } from '@stdlib/ndarray-matrix-ctor';\n\n\n// MAIN //\n\n/**\n* Returns a single-precision floating-point matrix (i.e., a two-dimensional ndarray).\n*\n* @name Float32Matrix\n* @type {Function}\n* @param {(NonNegativeInteger|NonNegativeIntegerArray|ArrayLikeObject|ArrayBuffer|Iterable)} [arg0] - shape, number of rows, array-like object, ArrayBuffer, or iterable\n* @param {NonNegativeInteger} [arg1] - number of columns or byte offset\n* @param {(NonNegativeInteger|NonNegativeIntegerArray)} [arg2] - shape or number of rows\n* @param {NonNegativeInteger} [arg3] - number of columns\n* @param {Options} [options] - function options\n* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only matrix\n* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed matrix dimensions\n* @param {StringArray} [options.submode=[options.mode]] - specifies how to handle subscripts which exceed array dimensions on a per dimension basis\n* @param {string} [options.order='row-major'] - memory layout (either row-major or column-major)\n* @throws {TypeError} first argument must be either a shape, integer, array-like object, ArrayBuffer, iterable, or options object\n* @throws {TypeError} must provide valid options\n* @returns {ndarray} two-dimensional ndarray\n*\n* @example\n* import getShape from '@stdlib/ndarray-shape';\n*\n* var v = new Float32Matrix();\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 0, 0 ]\n*\n* @example\n* import getShape from '@stdlib/ndarray-shape';\n*\n* var v = new Float32Matrix( [ 2, 2 ] );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 2 ]\n*\n* @example\n* import getShape from '@stdlib/ndarray-shape';\n*\n* var v = new Float32Matrix( 2, 2 );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 2 ]\n*\n* @example\n* import getShape from '@stdlib/ndarray-shape';\n*\n* var v = new Float32Matrix( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 2 ]\n*\n* @example\n* import ArrayBuffer from '@stdlib/array-buffer';\n* import getShape from '@stdlib/ndarray-shape';\n*\n* var buf = new ArrayBuffer( 32 );\n* var v = new Float32Matrix( buf );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 1, 8 ]\n*\n* @example\n* import ArrayBuffer from '@stdlib/array-buffer';\n* import getShape from '@stdlib/ndarray-shape';\n*\n* var buf = new ArrayBuffer( 32 );\n* var v = new Float32Matrix( buf, 16 );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 1, 4 ]\n*\n* @example\n* import ArrayBuffer from '@stdlib/array-buffer';\n* import getShape from '@stdlib/ndarray-shape';\n*\n* var buf = new ArrayBuffer( 64 );\n* var v = new Float32Matrix( buf, 16, [ 2, 1 ] );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 1 ]\n*\n* @example\n* import ArrayBuffer from '@stdlib/array-buffer';\n* import getShape from '@stdlib/ndarray-shape';\n*\n* var buf = new ArrayBuffer( 64 );\n* var v = new Float32Matrix( buf, 16, 2, 1 );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 1 ]\n*/\nvar Float32Matrix = factory( 'float32' );\n\n\n// EXPORTS //\n\nexport default Float32Matrix;\n"],"names":["Float32Matrix","factory"],"mappings":";;kGA6HG,IAACA,EAAgBC,EAAS"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index b62f3e6..0000000 --- a/lib/index.js +++ /dev/null @@ -1,122 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2026 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 a single-precision floating-point matrix (i.e., a two-dimensional ndarray). -* -* @module @stdlib/ndarray-matrix-float32 -* -* @example -* var getShape = require( '@stdlib/ndarray-shape' ); -* var Float32Matrix = require( '@stdlib/ndarray-matrix-float32' ); -* -* var v = new Float32Matrix(); -* // returns -* -* var len = getShape( v ); -* // returns [ 0, 0 ] -* -* @example -* var getShape = require( '@stdlib/ndarray-shape' ); -* var Float32Matrix = require( '@stdlib/ndarray-matrix-float32' ); -* -* var v = new Float32Matrix( [ 2, 2 ] ); -* // returns -* -* var len = getShape( v ); -* // returns [ 2, 2 ] -* -* @example -* var getShape = require( '@stdlib/ndarray-shape' ); -* var Float32Matrix = require( '@stdlib/ndarray-matrix-float32' ); -* -* var v = new Float32Matrix( 2, 2 ); -* // returns -* -* var len = getShape( v ); -* // returns [ 2, 2 ] -* -* @example -* var getShape = require( '@stdlib/ndarray-shape' ); -* var Float32Matrix = require( '@stdlib/ndarray-matrix-float32' ); -* -* var v = new Float32Matrix( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ); -* // returns -* -* var len = getShape( v ); -* // returns [ 2, 2 ] -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var getShape = require( '@stdlib/ndarray-shape' ); -* var Float32Matrix = require( '@stdlib/ndarray-matrix-float32' ); -* -* var buf = new ArrayBuffer( 32 ); -* var v = new Float32Matrix( buf ); -* // returns -* -* var len = getShape( v ); -* // returns [ 1, 8 ] -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var getShape = require( '@stdlib/ndarray-shape' ); -* var Float32Matrix = require( '@stdlib/ndarray-matrix-float32' ); -* -* var buf = new ArrayBuffer( 32 ); -* var v = new Float32Matrix( buf, 16 ); -* // returns -* -* var len = getShape( v ); -* // returns [ 1, 4 ] -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var getShape = require( '@stdlib/ndarray-shape' ); -* var Float32Matrix = require( '@stdlib/ndarray-matrix-float32' ); -* -* var buf = new ArrayBuffer( 64 ); -* var v = new Float32Matrix( buf, 16, [ 2, 1 ] ); -* // returns -* -* var len = getShape( v ); -* // returns [ 2, 1 ] -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var getShape = require( '@stdlib/ndarray-shape' ); -* var Float32Matrix = require( '@stdlib/ndarray-matrix-float32' ); -* -* var buf = new ArrayBuffer( 64 ); -* var v = new Float32Matrix( buf, 16, 2, 1 ); -* // returns -* -* var len = getShape( v ); -* // returns [ 2, 1 ] -*/ - -// MODULES // - -var main = require( './main.js' ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index a1e2693..0000000 --- a/lib/main.js +++ /dev/null @@ -1,131 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2026 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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( '@stdlib/ndarray-matrix-ctor' ).factory; - - -// MAIN // - -/** -* Returns a single-precision floating-point matrix (i.e., a two-dimensional ndarray). -* -* @name Float32Matrix -* @type {Function} -* @param {(NonNegativeInteger|NonNegativeIntegerArray|ArrayLikeObject|ArrayBuffer|Iterable)} [arg0] - shape, number of rows, array-like object, ArrayBuffer, or iterable -* @param {NonNegativeInteger} [arg1] - number of columns or byte offset -* @param {(NonNegativeInteger|NonNegativeIntegerArray)} [arg2] - shape or number of rows -* @param {NonNegativeInteger} [arg3] - number of columns -* @param {Options} [options] - function options -* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only matrix -* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed matrix dimensions -* @param {StringArray} [options.submode=[options.mode]] - specifies how to handle subscripts which exceed array dimensions on a per dimension basis -* @param {string} [options.order='row-major'] - memory layout (either row-major or column-major) -* @throws {TypeError} first argument must be either a shape, integer, array-like object, ArrayBuffer, iterable, or options object -* @throws {TypeError} must provide valid options -* @returns {ndarray} two-dimensional ndarray -* -* @example -* var getShape = require( '@stdlib/ndarray-shape' ); -* -* var v = new Float32Matrix(); -* // returns -* -* var len = getShape( v ); -* // returns [ 0, 0 ] -* -* @example -* var getShape = require( '@stdlib/ndarray-shape' ); -* -* var v = new Float32Matrix( [ 2, 2 ] ); -* // returns -* -* var len = getShape( v ); -* // returns [ 2, 2 ] -* -* @example -* var getShape = require( '@stdlib/ndarray-shape' ); -* -* var v = new Float32Matrix( 2, 2 ); -* // returns -* -* var len = getShape( v ); -* // returns [ 2, 2 ] -* -* @example -* var getShape = require( '@stdlib/ndarray-shape' ); -* -* var v = new Float32Matrix( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ); -* // returns -* -* var len = getShape( v ); -* // returns [ 2, 2 ] -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var getShape = require( '@stdlib/ndarray-shape' ); -* -* var buf = new ArrayBuffer( 32 ); -* var v = new Float32Matrix( buf ); -* // returns -* -* var len = getShape( v ); -* // returns [ 1, 8 ] -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var getShape = require( '@stdlib/ndarray-shape' ); -* -* var buf = new ArrayBuffer( 32 ); -* var v = new Float32Matrix( buf, 16 ); -* // returns -* -* var len = getShape( v ); -* // returns [ 1, 4 ] -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var getShape = require( '@stdlib/ndarray-shape' ); -* -* var buf = new ArrayBuffer( 64 ); -* var v = new Float32Matrix( buf, 16, [ 2, 1 ] ); -* // returns -* -* var len = getShape( v ); -* // returns [ 2, 1 ] -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var getShape = require( '@stdlib/ndarray-shape' ); -* -* var buf = new ArrayBuffer( 64 ); -* var v = new Float32Matrix( buf, 16, 2, 1 ); -* // returns -* -* var len = getShape( v ); -* // returns [ 2, 1 ] -*/ -var Float32Matrix = factory( 'float32' ); - - -// EXPORTS // - -module.exports = Float32Matrix; diff --git a/package.json b/package.json index d6f3604..fe36b21 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.0.0", "description": "Create a single-precision floating-point matrix (i.e., a two-dimensional ndarray).", "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,47 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/ndarray-matrix-ctor": "github:stdlib-js/ndarray-matrix-ctor#main", - "@stdlib/types": "^0.5.1" - }, - "devDependencies": { - "@stdlib/array-buffer": "^0.2.3", - "@stdlib/array-float32": "^0.2.3", - "@stdlib/assert-is-ndarray-like": "^0.2.3", - "@stdlib/assert-is-ndarray-like-with-data-type": "^0.1.1", - "@stdlib/assert-is-same-float32array": "^0.2.3", - "@stdlib/blas-ext-sum": "^0.1.1", - "@stdlib/math-base-special-floor": "^0.2.4", - "@stdlib/math-base-special-pow": "^0.3.1", - "@stdlib/ndarray-base-assert-is-read-only": "^0.2.3", - "@stdlib/ndarray-data-buffer": "^0.2.3", - "@stdlib/ndarray-map": "^0.1.1", - "@stdlib/ndarray-order": "^0.2.3", - "@stdlib/ndarray-shape": "^0.2.3", - "@stdlib/ndarray-to-array": "^0.2.2", - "@stdlib/random-array-discrete-uniform": "^0.2.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.3", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.3" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..0807e84 --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 65fdf78..0000000 --- a/test/test.js +++ /dev/null @@ -1,1394 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2026 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable no-new */ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var isndarrayLikeWithDataType = require( '@stdlib/assert-is-ndarray-like-with-data-type' ); -var isSameFloat32Array = require( '@stdlib/assert-is-same-float32array' ); -var isReadOnly = require( '@stdlib/ndarray-base-assert-is-read-only' ); -var ArrayBuffer = require( '@stdlib/array-buffer' ); -var Float32Array = require( '@stdlib/array-float32' ); -var getData = require( '@stdlib/ndarray-data-buffer' ); -var getShape = require( '@stdlib/ndarray-shape' ); -var getOrder = require( '@stdlib/ndarray-order' ); -var Float32Matrix = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof Float32Matrix, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if provided an invalid first argument', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1 ], - [ 1, 2, 3 ], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1 ], - [ 1, 2, 3 ], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( value, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (second argument)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( value, 0 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (second argument, options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( value, 0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (byteoffset, shape)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( value, 0, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (byteoffset, shape, options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( value, 0, [ 0, 0 ], {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (byteoffset, M, N)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( value, 0, 0, 0 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (byteoffset, M, N, options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( value, 0, 0, 0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid byte offset argument', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( new ArrayBuffer( 8 ), value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid byte offset argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( new ArrayBuffer( 8 ), value, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid byte offset argument (shape)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( new ArrayBuffer( 8 ), value, [ 1, 1 ] ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid byte offset argument (shape, options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( new ArrayBuffer( 8 ), value, [ 1, 1 ], {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid byte offset argument (M, N)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( new ArrayBuffer( 8 ), value, 1, 1 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid byte offset argument (M, N, options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( new ArrayBuffer( 8 ), value, 1, 1, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1 ], - [ 1, 1, 1 ], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( new ArrayBuffer( 8 ), 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1 ], - [ 1, 1, 1 ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( new ArrayBuffer( 8 ), 0, value, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid `M` argument', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1 ], - [ 1, 1, 1 ], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( new ArrayBuffer( 8 ), 0, value, 1 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid `M` argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1 ], - [ 1, 1, 1 ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( new ArrayBuffer( 8 ), 0, value, 1, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid `N` argument', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1 ], - [ 1, 1, 1 ], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( new ArrayBuffer( 8 ), 0, 1, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid `N` argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1 ], - [ 1, 1, 1 ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( new ArrayBuffer( 8 ), 0, 1, value, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (shape)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( [ 3, 3 ], value ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (M, N)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( 3, 3, value ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (array)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ], value ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (arraybuffer)', function test( t ) { - var values; - var i; - - values = [ - '5', - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( new ArrayBuffer( 8 ), value ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (arraybuffer, byteoffset)', function test( t ) { - var values; - var i; - - values = [ - '5', - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( new ArrayBuffer( 8 ), 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (arraybuffer, byteoffset, shape)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( new ArrayBuffer( 8 ), 0, [ 1, 1 ], value ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (arraybuffer, byteoffset, M, N)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( new ArrayBuffer( 8 ), 0, 1, 1, value ); - }; - } -}); - -tape( 'the function throws an error if provided an `order` option which is not a recognized order', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'ROW', - 'row', - 'col-major', - 'col', - 'major', - 'minor', - null - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix({ - 'order': value - }); - }; - } -}); - -tape( 'the function throws an error if provided a `mode` option which is not a recognized mode', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'THROW', - 5, - null, - true, - false, - [], - {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix({ - 'mode': value - }); - }; - } -}); - -tape( 'the function throws an error if provided a `mode` option which is not a recognized submode', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'THROW', - 5, - null, - true, - false, - [], - {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix({ - 'submode': [ value ] - }); - }; - } -}); - -tape( 'the function throws an error if provided a `readonly` option which is not a boolean', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - null, - void 0, - [], - {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix({ - 'readonly': value - }); - }; - } -}); - -tape( 'the function returns a two-dimensional ndarray', function test( t ) { - var arr; - - arr = new Float32Matrix(); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 0, 0 ], 'returns expected value' ); - - arr = new Float32Matrix( {} ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a two-dimensional ndarray (shape)', function test( t ) { - var arr; - - arr = new Float32Matrix( [ 3, 3 ] ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 3, 3 ], 'returns expected value' ); - - arr = new Float32Matrix( [ 3, 3 ], {} ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 3, 3 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a two-dimensional ndarray (M, N)', function test( t ) { - var arr; - - arr = new Float32Matrix( 3, 3 ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 3, 3 ], 'returns expected value' ); - - arr = new Float32Matrix( 3, 3, {} ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 3, 3 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a two-dimensional ndarray (array)', function test( t ) { - var arr; - var out; - - arr = [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]; - - out = new Float32Matrix( arr ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( out ), [ 2, 2 ], 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( [ 1.0, 2.0, 3.0, 4.0 ] ) ), true, 'returns expected value' ); - - out = new Float32Matrix( arr, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( out ), [ 2, 2 ], 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( [ 1.0, 2.0, 3.0, 4.0 ] ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a two-dimensional ndarray (arraybuffer)', function test( t ) { - var buf; - var out; - - buf = new ArrayBuffer( 16 ); - - out = new Float32Matrix( buf ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( out ), [ 1, 4 ], 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf ) ), true, 'returns expected value' ); - - out = new Float32Matrix( buf, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( out ), [ 1, 4 ], 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a two-dimensional ndarray (arraybuffer, byteoffset)', function test( t ) { - var buf; - var out; - - buf = new ArrayBuffer( 64 ); - - out = new Float32Matrix( buf, 8 ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( out ), [ 1, 14 ], 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf, 8 ) ), true, 'returns expected value' ); - - out = new Float32Matrix( buf, 8, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( out ), [ 1, 14 ], 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf, 8 ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a two-dimensional ndarray (arraybuffer, byteoffset, shape)', function test( t ) { - var buf; - var out; - - buf = new ArrayBuffer( 64 ); - - out = new Float32Matrix( buf, 8, [ 2, 1 ] ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( out ), [ 2, 1 ], 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf, 8, 2 ) ), true, 'returns expected value' ); - - out = new Float32Matrix( buf, 8, [ 2, 1 ], {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( out ), [ 2, 1 ], 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf, 8, 2 ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a two-dimensional ndarray (arraybuffer, byteoffset, M, N)', function test( t ) { - var buf; - var out; - - buf = new ArrayBuffer( 64 ); - - out = new Float32Matrix( buf, 8, 2, 1 ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( out ), [ 2, 1 ], 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf, 8, 2 ) ), true, 'returns expected value' ); - - out = new Float32Matrix( buf, 8, 2, 1, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( out ), [ 2, 1 ], 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf, 8, 2 ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout', function test( t ) { - var arr; - - arr = new Float32Matrix({ - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 0, 0 ], 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Float32Matrix({ - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 0, 0 ], 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (shape)', function test( t ) { - var arr; - - arr = new Float32Matrix( [ 3, 3 ], { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 3, 3 ], 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Float32Matrix( [ 3, 3 ], { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 3, 3 ], 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (array)', function test( t ) { - var arr; - - arr = new Float32Matrix( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ], { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 2, 2 ], 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Float32Matrix( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ], { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 2, 2 ], 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (arraybuffer)', function test( t ) { - var arr; - - arr = new Float32Matrix( new ArrayBuffer( 64 ), { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 1, 16 ], 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Float32Matrix( new ArrayBuffer( 64 ), { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 1, 16 ], 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (arraybuffer, byteoffset)', function test( t ) { - var arr; - - arr = new Float32Matrix( new ArrayBuffer( 64 ), 8, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 1, 14 ], 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Float32Matrix( new ArrayBuffer( 64 ), 8, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 1, 14 ], 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (arraybuffer, byteoffset, shape)', function test( t ) { - var arr; - - arr = new Float32Matrix( new ArrayBuffer( 64 ), 8, [ 2, 1 ], { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 2, 1 ], 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Float32Matrix( new ArrayBuffer( 64 ), 8, [ 2, 1 ], { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 2, 1 ], 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (arraybuffer, byteoffset, M, N)', function test( t ) { - var arr; - - arr = new Float32Matrix( new ArrayBuffer( 64 ), 8, 2, 1, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 2, 1 ], 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Float32Matrix( new ArrayBuffer( 64 ), 8, 2, 1, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 2, 1 ], 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning read-only ndarrays', function test( t ) { - var arr; - - arr = new Float32Matrix({ - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 0, 0 ], 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning read-only ndarrays (shape)', function test( t ) { - var arr; - - arr = new Float32Matrix( [ 3, 3 ], { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 3, 3 ], 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning read-only ndarrays (array)', function test( t ) { - var arr; - - arr = new Float32Matrix( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ], { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 2, 2 ], 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning read-only ndarrays (arraybuffer)', function test( t ) { - var arr; - - arr = new Float32Matrix( new ArrayBuffer( 64 ), { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 1, 16 ], 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning read-only ndarrays (arraybuffer, byteoffset)', function test( t ) { - var arr; - - arr = new Float32Matrix( new ArrayBuffer( 64 ), 8, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 1, 14 ], 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning read-only ndarrays (arraybuffer, byteoffset, shape)', function test( t ) { - var arr; - - arr = new Float32Matrix( new ArrayBuffer( 64 ), 8, [ 2, 1 ], { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 2, 1 ], 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning read-only ndarrays (arraybuffer, byteoffset, M, N)', function test( t ) { - var arr; - - arr = new Float32Matrix( new ArrayBuffer( 64 ), 8, 2, 1, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 2, 1 ], 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning writable ndarrays', function test( t ) { - var arr; - - arr = new Float32Matrix({ - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 0, 0 ], 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning writable ndarrays (shape)', function test( t ) { - var arr; - - arr = new Float32Matrix( [ 3, 3 ], { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 3, 3 ], 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning writable ndarrays (array)', function test( t ) { - var arr; - - arr = new Float32Matrix( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ], { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 2, 2 ], 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning writable ndarrays (arraybuffer)', function test( t ) { - var arr; - - arr = new Float32Matrix( new ArrayBuffer( 64 ), { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 1, 16 ], 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning writable ndarrays (arraybuffer, byteoffset)', function test( t ) { - var arr; - - arr = new Float32Matrix( new ArrayBuffer( 64 ), 8, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 1, 14 ], 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning writable ndarrays (arraybuffer, byteoffset, shape)', function test( t ) { - var arr; - - arr = new Float32Matrix( new ArrayBuffer( 64 ), 8, [ 2, 1 ], { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 2, 1 ], 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning writable ndarrays (arraybuffer, byteoffset, M, N)', function test( t ) { - var arr; - - arr = new Float32Matrix( new ArrayBuffer( 64 ), 8, 2, 1, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 2, 1 ], 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); From 7fc6cd5f66dadbe8ac09c80d1609afc5b4c4e0d9 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 7 Jul 2026 04:58:56 +0000 Subject: [PATCH 09/11] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 0177c84..d6f3604 100644 --- a/package.json +++ b/package.json @@ -56,7 +56,7 @@ "@stdlib/ndarray-shape": "^0.2.3", "@stdlib/ndarray-to-array": "^0.2.2", "@stdlib/random-array-discrete-uniform": "^0.2.2", - "@stdlib/string-format": "^0.2.3", + "@stdlib/error-tools-fmtprodmsg": "^0.2.3", "tape": "git+https://github.com/kgryte/tape.git#fix/globby", "istanbul": "^0.4.1", "tap-min": "git+https://github.com/Planeshifter/tap-min.git", From ea34d8be5c6c9626de3ec6de19df85f0a06db5d9 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 7 Jul 2026 05:16:32 +0000 Subject: [PATCH 10/11] Remove files --- index.d.ts | 532 ------ index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5379 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 fb5eb97..0000000 --- a/index.d.ts +++ /dev/null @@ -1,532 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2026 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 - -/* eslint-disable @typescript-eslint/unified-signatures */ - -/// - -import { Order, Mode, float32ndarray, Shape2D } from '@stdlib/types/ndarray'; -import { Collection, AccessorArrayLike, ArrayLike } from '@stdlib/types/array'; -import ArrayBuffer = require( '@stdlib/array-buffer' ); - -/** -* Interface describing function options. -*/ -interface Options { - /** - * Array order (either 'row-major' (C-style) or 'column-major' (Fortran-style)). - */ - order?: Order; - - /** - * Specifies how to handle a linear index which exceeds array dimensions (default: 'throw'). - */ - mode?: Mode; - - /** - * Specifies how to handle subscripts which exceed array dimensions on a per dimension basis (default: ['throw']). - */ - submode?: ArrayLike; - - /** - * Boolean indicating whether an array should be read-only (default: false). - */ - readonly?: boolean; -} - -/** -* Interface defining a typed matrix constructor which is both "newable" and "callable". -*/ -interface Float32Matrix { - /** - * Creates a single-precision floating-point matrix (i.e., a two-dimensional ndarray). - * - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only matrix - * @param options.mode - specifies how to handle indices which exceed matrix dimensions - * @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis - * @param options.order - memory layout (either row-major or column-major) - * @returns two-dimensional ndarray - * - * @example - * var getShape = require( '@stdlib/ndarray-shape' ); - * - * var arr = new Float32Matrix(); - * // returns - * - * var sh = getShape( arr ); - * // returns [ 0, 0 ] - */ - new ( options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point matrix (i.e., a two-dimensional ndarray). - * - * @param shape - matrix shape - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only matrix - * @param options.mode - specifies how to handle indices which exceed matrix dimensions - * @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis - * @param options.order - memory layout (either row-major or column-major) - * @returns two-dimensional ndarray - * - * @example - * var getShape = require( '@stdlib/ndarray-shape' ); - * - * var arr = new Float32Matrix( [ 2, 2 ] ); - * // returns - * - * var sh = getShape( arr ); - * // returns [ 2, 2 ] - */ - new ( shape: Shape2D, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point matrix (i.e., a two-dimensional ndarray). - * - * @param M - number of rows - * @param N - number of columns - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only matrix - * @param options.mode - specifies how to handle indices which exceed matrix dimensions - * @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis - * @param options.order - memory layout (either row-major or column-major) - * @returns two-dimensional ndarray - * - * @example - * var getShape = require( '@stdlib/ndarray-shape' ); - * - * var arr = new Float32Matrix( 2, 2 ); - * // returns - * - * var sh = getShape( arr ); - * // returns [ 2, 2 ] - */ - new ( M: number, N: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point matrix (i.e., a two-dimensional ndarray). - * - * @param obj - array-like object or iterable from which to generate a matrix - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only matrix - * @param options.mode - specifies how to handle indices which exceed matrix dimensions - * @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis - * @param options.order - memory layout (either row-major or column-major) - * @returns two-dimensional ndarray - * - * @example - * var getShape = require( '@stdlib/ndarray-shape' ); - * - * var arr = new Float32Matrix( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ); - * // returns - * - * var sh = getShape( arr ); - * // returns [ 2, 2 ] - */ - new ( obj: ArrayLike | AccessorArrayLike> | Iterable | AccessorArrayLike>, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point matrix (i.e., a two-dimensional ndarray). - * - * ## Notes - * - * - The returned ndarray view spans the entirety of the underlying ArrayBuffer and the leading dimension of the returned ndarray always has a size of one. - * - * @param buffer - underlying ArrayBuffer - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only matrix - * @param options.mode - specifies how to handle indices which exceed matrix dimensions - * @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis - * @param options.order - memory layout (either row-major or column-major) - * @returns two-dimensional ndarray - * - * @example - * var getShape = require( '@stdlib/ndarray-shape' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Matrix( buf ); - * // returns - * - * var sh = getShape( arr ); - * // returns [ 1, 8 ] - */ - new ( buffer: ArrayBuffer, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point matrix (i.e., a two-dimensional ndarray). - * - * ## Notes - * - * - The returned ndarray view spans from the byteOffset to the end of the underlying ArrayBuffer and the leading dimension of the returned ndarray always has a size of one. - * - * @param buffer - underlying ArrayBuffer - * @param byteOffset - integer byte offset specifying the location of the first matrix element - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only matrix - * @param options.mode - specifies how to handle indices which exceed matrix dimensions - * @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis - * @param options.order - memory layout (either row-major or column-major) - * @returns two-dimensional ndarray - * - * @example - * var getShape = require( '@stdlib/ndarray-shape' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Matrix( buf, 8 ); - * // returns - * - * var sh = getShape( arr ); - * // returns [ 1, 6 ] - */ - new ( buffer: ArrayBuffer, byteOffset: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point matrix (i.e., a two-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param byteOffset - integer byte offset specifying the location of the first matrix element - * @param shape - matrix shape - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only matrix - * @param options.mode - specifies how to handle indices which exceed matrix dimensions - * @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis - * @param options.order - memory layout (either row-major or column-major) - * @returns two-dimensional ndarray - * - * @example - * var getShape = require( '@stdlib/ndarray-shape' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Matrix( buf, 8, [ 2, 1 ] ); - * // returns - * - * var sh = getShape( arr ); - * // returns [ 2, 1 ] - */ - new ( buffer: ArrayBuffer, byteOffset: number, shape: Shape2D, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point matrix (i.e., a two-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param byteOffset - integer byte offset specifying the location of the first matrix element - * @param M - number of rows - * @param N - number of columns - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only matrix - * @param options.mode - specifies how to handle indices which exceed matrix dimensions - * @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis - * @param options.order - memory layout (either row-major or column-major) - * @returns two-dimensional ndarray - * - * @example - * var getShape = require( '@stdlib/ndarray-shape' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Matrix( buf, 8, 2, 1 ); - * // returns - * - * var sh = getShape( arr ); - * // returns [ 2, 1 ] - */ - new ( buffer: ArrayBuffer, byteOffset: number, M: number, N: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point matrix (i.e., a two-dimensional ndarray). - * - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only matrix - * @param options.mode - specifies how to handle indices which exceed matrix dimensions - * @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis - * @param options.order - memory layout (either row-major or column-major) - * @returns two-dimensional ndarray - * - * @example - * var getShape = require( '@stdlib/ndarray-shape' ); - * - * var arr = new Float32Matrix(); - * // returns - * - * var sh = getShape( arr ); - * // returns [ 0, 0 ] - */ - ( options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point matrix (i.e., a two-dimensional ndarray). - * - * @param shape - matrix shape - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only matrix - * @param options.mode - specifies how to handle indices which exceed matrix dimensions - * @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis - * @param options.order - memory layout (either row-major or column-major) - * @returns two-dimensional ndarray - * - * @example - * var getShape = require( '@stdlib/ndarray-shape' ); - * - * var arr = new Float32Matrix( [ 2, 2 ] ); - * // returns - * - * var sh = getShape( arr ); - * // returns [ 2, 2 ] - */ - ( shape: Shape2D, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point matrix (i.e., a two-dimensional ndarray). - * - * @param M - number of rows - * @param N - number of columns - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only matrix - * @param options.mode - specifies how to handle indices which exceed matrix dimensions - * @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis - * @param options.order - memory layout (either row-major or column-major) - * @returns two-dimensional ndarray - * - * @example - * var getShape = require( '@stdlib/ndarray-shape' ); - * - * var arr = new Float32Matrix( 2, 2 ); - * // returns - * - * var sh = getShape( arr ); - * // returns [ 2, 2 ] - */ - ( M: number, N: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point matrix (i.e., a two-dimensional ndarray). - * - * @param obj - array-like object or iterable from which to generate a matrix - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only matrix - * @param options.mode - specifies how to handle indices which exceed matrix dimensions - * @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis - * @param options.order - memory layout (either row-major or column-major) - * @returns two-dimensional ndarray - * - * @example - * var getShape = require( '@stdlib/ndarray-shape' ); - * - * var arr = new Float32Matrix( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ); - * // returns - * - * var sh = getShape( arr ); - * // returns [ 2, 2 ] - */ - ( obj: ArrayLike | AccessorArrayLike> | Iterable | AccessorArrayLike>, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point matrix (i.e., a two-dimensional ndarray). - * - * ## Notes - * - * - The returned ndarray view spans the entirety of the underlying ArrayBuffer and the leading dimension of the returned ndarray always has a size of one. - * - * @param buffer - underlying ArrayBuffer - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only matrix - * @param options.mode - specifies how to handle indices which exceed matrix dimensions - * @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis - * @param options.order - memory layout (either row-major or column-major) - * @returns two-dimensional ndarray - * - * @example - * var getShape = require( '@stdlib/ndarray-shape' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Matrix( buf ); - * // returns - * - * var sh = getShape( arr ); - * // returns [ 1, 8 ] - */ - ( buffer: ArrayBuffer, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point matrix (i.e., a two-dimensional ndarray). - * - * ## Notes - * - * - The returned ndarray view spans from the byteOffset to the end of the underlying ArrayBuffer and the leading dimension of the returned ndarray always has a size of one. - * - * @param buffer - underlying ArrayBuffer - * @param byteOffset - integer byte offset specifying the location of the first matrix element - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only matrix - * @param options.mode - specifies how to handle indices which exceed matrix dimensions - * @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis - * @param options.order - memory layout (either row-major or column-major) - * @returns two-dimensional ndarray - * - * @example - * var getShape = require( '@stdlib/ndarray-shape' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Matrix( buf, 8 ); - * // returns - * - * var sh = getShape( arr ); - * // returns [ 1, 6 ] - */ - ( buffer: ArrayBuffer, byteOffset: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point matrix (i.e., a two-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param byteOffset - integer byte offset specifying the location of the first matrix element - * @param shape - matrix shape - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only matrix - * @param options.mode - specifies how to handle indices which exceed matrix dimensions - * @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis - * @param options.order - memory layout (either row-major or column-major) - * @returns two-dimensional ndarray - * - * @example - * var getShape = require( '@stdlib/ndarray-shape' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Matrix( buf, 8, [ 2, 1 ] ); - * // returns - * - * var sh = getShape( arr ); - * // returns [ 2, 1 ] - */ - ( buffer: ArrayBuffer, byteOffset: number, shape: Shape2D, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point matrix (i.e., a two-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param byteOffset - integer byte offset specifying the location of the first matrix element - * @param M - number of rows - * @param N - number of columns - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only matrix - * @param options.mode - specifies how to handle indices which exceed matrix dimensions - * @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis - * @param options.order - memory layout (either row-major or column-major) - * @returns two-dimensional ndarray - * - * @example - * var getShape = require( '@stdlib/ndarray-shape' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Matrix( buf, 8, 2, 1 ); - * // returns - * - * var sh = getShape( arr ); - * // returns [ 2, 1 ] - */ - ( buffer: ArrayBuffer, byteOffset: number, M: number, N: number, options?: Options ): float32ndarray; -} - -/** -* Creates a single-precision floating-point matrix (i.e., a two-dimensional ndarray). -* -* @param arg0 - shape, number of rows, array-like object, ArrayBuffer, or iterable -* @param arg1 - number of columns or integer byte offset specifying the location of the first matrix element -* @param arg2 - matrix shape or number of rows -* @param arg3 - number of columns -* @param options - function options -* @param options.readonly - boolean indicating whether to return a read-only matrix -* @param options.mode - specifies how to handle indices which exceed matrix dimensions -* @param options.submode - specifies how to handle subscripts which exceed array dimensions on a per dimension basis -* @param options.order - memory layout (either row-major or column-major) -* @returns two-dimensional ndarray -* -* @example -* var getShape = require( '@stdlib/ndarray-shape' ); -* -* var arr = new Float32Matrix(); -* // returns -* -* var sh = getShape( arr ); -* // returns [ 0, 0 ] -* -* @example -* var getShape = require( '@stdlib/ndarray-shape' ); -* -* var arr = new Float32Matrix( [ 2, 2 ] ); -* // returns -* -* var sh = getShape( arr ); -* // returns [ 2, 2 ] -* -* @example -* var getShape = require( '@stdlib/ndarray-shape' ); -* -* var arr = new Float32Matrix( 2, 2 ); -* // returns -* -* var sh = getShape( arr ); -* // returns [ 2, 2 ] -* -* @example -* var getShape = require( '@stdlib/ndarray-shape' ); -* -* var arr = new Float32Matrix( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ); -* // returns -* -* var sh = getShape( arr ); -* // returns [ 2, 2 ] -* -* @example -* var getShape = require( '@stdlib/ndarray-shape' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 32 ); -* var arr = new Float32Matrix( buf, 8, [ 2, 1 ] ); -* // returns -* -* var sh = getShape( arr ); -* // returns [ 2, 1 ] -* -* @example -* var getShape = require( '@stdlib/ndarray-shape' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 32 ); -* var arr = new Float32Matrix( buf, 8, 2, 1 ); -* // returns -* -* var sh = getShape( arr ); -* // returns [ 2, 1 ] -*/ -declare var ctor: Float32Matrix; - - -// EXPORTS // - -export = ctor; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index d687205..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import{factory as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-matrix-ctor@esm/index.mjs";var r=t("float32");export{r as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 1fc582f..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2026 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* 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 as factory } from '@stdlib/ndarray-matrix-ctor';\n\n\n// MAIN //\n\n/**\n* Returns a single-precision floating-point matrix (i.e., a two-dimensional ndarray).\n*\n* @name Float32Matrix\n* @type {Function}\n* @param {(NonNegativeInteger|NonNegativeIntegerArray|ArrayLikeObject|ArrayBuffer|Iterable)} [arg0] - shape, number of rows, array-like object, ArrayBuffer, or iterable\n* @param {NonNegativeInteger} [arg1] - number of columns or byte offset\n* @param {(NonNegativeInteger|NonNegativeIntegerArray)} [arg2] - shape or number of rows\n* @param {NonNegativeInteger} [arg3] - number of columns\n* @param {Options} [options] - function options\n* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only matrix\n* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed matrix dimensions\n* @param {StringArray} [options.submode=[options.mode]] - specifies how to handle subscripts which exceed array dimensions on a per dimension basis\n* @param {string} [options.order='row-major'] - memory layout (either row-major or column-major)\n* @throws {TypeError} first argument must be either a shape, integer, array-like object, ArrayBuffer, iterable, or options object\n* @throws {TypeError} must provide valid options\n* @returns {ndarray} two-dimensional ndarray\n*\n* @example\n* import getShape from '@stdlib/ndarray-shape';\n*\n* var v = new Float32Matrix();\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 0, 0 ]\n*\n* @example\n* import getShape from '@stdlib/ndarray-shape';\n*\n* var v = new Float32Matrix( [ 2, 2 ] );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 2 ]\n*\n* @example\n* import getShape from '@stdlib/ndarray-shape';\n*\n* var v = new Float32Matrix( 2, 2 );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 2 ]\n*\n* @example\n* import getShape from '@stdlib/ndarray-shape';\n*\n* var v = new Float32Matrix( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 2 ]\n*\n* @example\n* import ArrayBuffer from '@stdlib/array-buffer';\n* import getShape from '@stdlib/ndarray-shape';\n*\n* var buf = new ArrayBuffer( 32 );\n* var v = new Float32Matrix( buf );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 1, 8 ]\n*\n* @example\n* import ArrayBuffer from '@stdlib/array-buffer';\n* import getShape from '@stdlib/ndarray-shape';\n*\n* var buf = new ArrayBuffer( 32 );\n* var v = new Float32Matrix( buf, 16 );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 1, 4 ]\n*\n* @example\n* import ArrayBuffer from '@stdlib/array-buffer';\n* import getShape from '@stdlib/ndarray-shape';\n*\n* var buf = new ArrayBuffer( 64 );\n* var v = new Float32Matrix( buf, 16, [ 2, 1 ] );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 1 ]\n*\n* @example\n* import ArrayBuffer from '@stdlib/array-buffer';\n* import getShape from '@stdlib/ndarray-shape';\n*\n* var buf = new ArrayBuffer( 64 );\n* var v = new Float32Matrix( buf, 16, 2, 1 );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 1 ]\n*/\nvar Float32Matrix = factory( 'float32' );\n\n\n// EXPORTS //\n\nexport default Float32Matrix;\n"],"names":["Float32Matrix","factory"],"mappings":";;kGA6HG,IAACA,EAAgBC,EAAS"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 0807e84..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From a879bcd0b671c78997929f82b8be2e009d6d771a Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 7 Jul 2026 05:17:36 +0000 Subject: [PATCH 11/11] Auto-generated commit --- .editorconfig | 189 - .eslintrc.js | 1 - .gitattributes | 68 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 821 --- .github/workflows/publish.yml | 261 - .github/workflows/test.yml | 101 - .github/workflows/test_bundles.yml | 213 - .github/workflows/test_coverage.yml | 142 - .github/workflows/test_install.yml | 94 - .github/workflows/test_published_package.yml | 115 - .gitignore | 204 - .npmignore | 229 - .npmrc | 44 - CHANGELOG.md | 52 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 75 +- SECURITY.md | 5 - benchmark/benchmark.js | 47 - benchmark/benchmark.size.js | 95 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 361 -- docs/types/test.ts | 100 - examples/index.js | 51 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 122 - lib/main.js | 131 - package.json | 68 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 1394 ----- 44 files changed, 4883 insertions(+), 5981 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .github/workflows/test_published_package.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 benchmark/benchmark.size.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 (99%) create mode 100644 index.mjs create mode 100644 index.mjs.map 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.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 80f3fca..0000000 --- a/.editorconfig +++ /dev/null @@ -1,189 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim. - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Ignore generated lock files for GitHub Agentic Workflows: -[*.lock.yml] -charset = unset -end_of_line = unset -indent_style = unset -indent_size = unset -trim_trailing_whitespace = unset -insert_final_newline = unset - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 24b327f..0000000 --- a/.gitattributes +++ /dev/null @@ -1,68 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation - -.github/workflows/*.lock.yml linguist-generated=true merge=ours diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 13e3774..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/ndarray/matrix/float32) 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 6686a6b..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/ndarray/matrix/float32) 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 bfaf214..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: '2 2 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 83d50c4..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,821 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send notification to Zulip if job fails: - - name: 'Send notification to Zulip in case of failure' - # Pin action to full length commit SHA - uses: zulip/github-actions-zulip/send-message@e4c8f27c732ba9bd98ac6be0583096dea82feea5 # v1.0.2 - if: failure() - with: - api-key: ${{ secrets.ZULIP_API_KEY }} - email: 'github-actions-bot@stdlib.zulipchat.com' - organization-url: 'https://stdlib.zulipchat.com' - to: 'workflows-standalone' - type: 'stream' - topic: ${{ github.event.repository.name }} - content: | - :cross_mark: **${{ github.workflow }}** workflow failed - - **Repository:** [${{ github.repository }}](${{ github.server_url }}/${{ github.repository }}) - **Run:** [View workflow run](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}) - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -313,7 +304,7 @@ console.log( ndarray2array( v ) ); ## 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]. @@ -376,23 +367,23 @@ Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-matrix-float32/main/LICENSE -[@stdlib/array/buffer]: https://github.com/stdlib-js/array-buffer +[@stdlib/array/buffer]: https://github.com/stdlib-js/array-buffer/tree/esm -[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor +[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor/tree/esm -[@stdlib/ndarray/matrix/float64]: https://github.com/stdlib-js/ndarray-matrix-float64 +[@stdlib/ndarray/matrix/float64]: https://github.com/stdlib-js/ndarray-matrix-float64/tree/esm -[@stdlib/ndarray/matrix/int32]: https://github.com/stdlib-js/ndarray-matrix-int32 +[@stdlib/ndarray/matrix/int32]: https://github.com/stdlib-js/ndarray-matrix-int32/tree/esm -[@stdlib/ndarray/matrix/complex128]: https://github.com/stdlib-js/ndarray-matrix-complex128 +[@stdlib/ndarray/matrix/complex128]: https://github.com/stdlib-js/ndarray-matrix-complex128/tree/esm -[@stdlib/ndarray/matrix/complex64]: https://github.com/stdlib-js/ndarray-matrix-complex64 +[@stdlib/ndarray/matrix/complex64]: https://github.com/stdlib-js/ndarray-matrix-complex64/tree/esm -[@stdlib/ndarray/matrix/ctor]: https://github.com/stdlib-js/ndarray-matrix-ctor +[@stdlib/ndarray/matrix/ctor]: https://github.com/stdlib-js/ndarray-matrix-ctor/tree/esm -[@stdlib/ndarray/vector/float32]: https://github.com/stdlib-js/ndarray-vector-float32 +[@stdlib/ndarray/vector/float32]: https://github.com/stdlib-js/ndarray-vector-float32/tree/esm diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 03b1296..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,47 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2026 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var pkg = require( './../package.json' ).name; -var Float32Matrix = require( './../lib' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var arr; - var i; - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr = new Float32Matrix( 0, 0 ); - if ( arr.length !== 0 ) { - b.fail( 'should have length 0' ); - } - } - b.toc(); - if ( !isndarrayLike( arr ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/benchmark/benchmark.size.js b/benchmark/benchmark.size.js deleted file mode 100644 index 664d979..0000000 --- a/benchmark/benchmark.size.js +++ /dev/null @@ -1,95 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2026 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var Float32Matrix = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveIntegerArray} shape - array shape -* @returns {Function} benchmark function -*/ -function createBenchmark( shape ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var arr; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr = new Float32Matrix( shape ); - if ( typeof arr !== 'object' ) { - b.fail( 'should return an ndarray' ); - } - } - b.toc(); - if ( !isndarrayLike( arr ) ) { - b.fail( 'should return an ndarray' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var N; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - N = floor( pow( pow( 10, i ), 1.0/2.0 ) ); - f = createBenchmark( [ N, N ] ); - bench( format( '%s::equidimensional:size=%d', pkg, N*N ), f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 7b916fa..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/ndarray/matrix/float32" -%% click B href "https://github.com/stdlib-js/ndarray-matrix-float32/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-matrix-float32/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-matrix-float32/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-matrix-float32/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-matrix-float32/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/matrix/float32 -[production-url]: https://github.com/stdlib-js/ndarray-matrix-float32/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-matrix-float32/tree/deno -[deno-readme]: https://github.com/stdlib-js/ndarray-matrix-float32/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/ndarray-matrix-float32/tree/umd -[umd-readme]: https://github.com/stdlib-js/ndarray-matrix-float32/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/ndarray-matrix-float32/tree/esm -[esm-readme]: https://github.com/stdlib-js/ndarray-matrix-float32/blob/esm/README.md \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index 0b44231..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import ctor from '../docs/types/index'; -export = ctor; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 26cde3c..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var o=function(e,r){return function(){try{return r||e((r={exports:{}}).exports,r),r.exports}catch(i){throw (r=0, i)}};};var a=o(function(v,t){ -var s=require('@stdlib/ndarray-matrix-ctor/dist').factory,c=s("float32");t.exports=c -});var u=a();module.exports=u; -/** @license Apache-2.0 */ -//# sourceMappingURL=index.js.map diff --git a/dist/index.js.map b/dist/index.js.map deleted file mode 100644 index a628c0a..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/main.js", "../lib/index.js"], - "sourcesContent": ["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2026 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* 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( '@stdlib/ndarray-matrix-ctor' ).factory;\n\n\n// MAIN //\n\n/**\n* Returns a single-precision floating-point matrix (i.e., a two-dimensional ndarray).\n*\n* @name Float32Matrix\n* @type {Function}\n* @param {(NonNegativeInteger|NonNegativeIntegerArray|ArrayLikeObject|ArrayBuffer|Iterable)} [arg0] - shape, number of rows, array-like object, ArrayBuffer, or iterable\n* @param {NonNegativeInteger} [arg1] - number of columns or byte offset\n* @param {(NonNegativeInteger|NonNegativeIntegerArray)} [arg2] - shape or number of rows\n* @param {NonNegativeInteger} [arg3] - number of columns\n* @param {Options} [options] - function options\n* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only matrix\n* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed matrix dimensions\n* @param {StringArray} [options.submode=[options.mode]] - specifies how to handle subscripts which exceed array dimensions on a per dimension basis\n* @param {string} [options.order='row-major'] - memory layout (either row-major or column-major)\n* @throws {TypeError} first argument must be either a shape, integer, array-like object, ArrayBuffer, iterable, or options object\n* @throws {TypeError} must provide valid options\n* @returns {ndarray} two-dimensional ndarray\n*\n* @example\n* var getShape = require( '@stdlib/ndarray-shape' );\n*\n* var v = new Float32Matrix();\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 0, 0 ]\n*\n* @example\n* var getShape = require( '@stdlib/ndarray-shape' );\n*\n* var v = new Float32Matrix( [ 2, 2 ] );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 2 ]\n*\n* @example\n* var getShape = require( '@stdlib/ndarray-shape' );\n*\n* var v = new Float32Matrix( 2, 2 );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 2 ]\n*\n* @example\n* var getShape = require( '@stdlib/ndarray-shape' );\n*\n* var v = new Float32Matrix( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 2 ]\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var getShape = require( '@stdlib/ndarray-shape' );\n*\n* var buf = new ArrayBuffer( 32 );\n* var v = new Float32Matrix( buf );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 1, 8 ]\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var getShape = require( '@stdlib/ndarray-shape' );\n*\n* var buf = new ArrayBuffer( 32 );\n* var v = new Float32Matrix( buf, 16 );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 1, 4 ]\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var getShape = require( '@stdlib/ndarray-shape' );\n*\n* var buf = new ArrayBuffer( 64 );\n* var v = new Float32Matrix( buf, 16, [ 2, 1 ] );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 1 ]\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var getShape = require( '@stdlib/ndarray-shape' );\n*\n* var buf = new ArrayBuffer( 64 );\n* var v = new Float32Matrix( buf, 16, 2, 1 );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 1 ]\n*/\nvar Float32Matrix = factory( 'float32' );\n\n\n// EXPORTS //\n\nmodule.exports = Float32Matrix;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2026 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 a single-precision floating-point matrix (i.e., a two-dimensional ndarray).\n*\n* @module @stdlib/ndarray-matrix-float32\n*\n* @example\n* var getShape = require( '@stdlib/ndarray-shape' );\n* var Float32Matrix = require( '@stdlib/ndarray-matrix-float32' );\n*\n* var v = new Float32Matrix();\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 0, 0 ]\n*\n* @example\n* var getShape = require( '@stdlib/ndarray-shape' );\n* var Float32Matrix = require( '@stdlib/ndarray-matrix-float32' );\n*\n* var v = new Float32Matrix( [ 2, 2 ] );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 2 ]\n*\n* @example\n* var getShape = require( '@stdlib/ndarray-shape' );\n* var Float32Matrix = require( '@stdlib/ndarray-matrix-float32' );\n*\n* var v = new Float32Matrix( 2, 2 );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 2 ]\n*\n* @example\n* var getShape = require( '@stdlib/ndarray-shape' );\n* var Float32Matrix = require( '@stdlib/ndarray-matrix-float32' );\n*\n* var v = new Float32Matrix( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 2 ]\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var getShape = require( '@stdlib/ndarray-shape' );\n* var Float32Matrix = require( '@stdlib/ndarray-matrix-float32' );\n*\n* var buf = new ArrayBuffer( 32 );\n* var v = new Float32Matrix( buf );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 1, 8 ]\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var getShape = require( '@stdlib/ndarray-shape' );\n* var Float32Matrix = require( '@stdlib/ndarray-matrix-float32' );\n*\n* var buf = new ArrayBuffer( 32 );\n* var v = new Float32Matrix( buf, 16 );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 1, 4 ]\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var getShape = require( '@stdlib/ndarray-shape' );\n* var Float32Matrix = require( '@stdlib/ndarray-matrix-float32' );\n*\n* var buf = new ArrayBuffer( 64 );\n* var v = new Float32Matrix( buf, 16, [ 2, 1 ] );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 1 ]\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var getShape = require( '@stdlib/ndarray-shape' );\n* var Float32Matrix = require( '@stdlib/ndarray-matrix-float32' );\n*\n* var buf = new ArrayBuffer( 64 );\n* var v = new Float32Matrix( buf, 16, 2, 1 );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 1 ]\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "iIAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,QAAS,6BAA8B,EAAE,QAuGnDC,EAAgBD,EAAS,SAAU,EAKvCD,EAAO,QAAUE,ICdjB,IAAIC,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "factory", "Float32Matrix", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index b0bbaa9..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,361 +0,0 @@ - -{{alias}}( [options] ) - Returns a two-dimensional single-precision floating-point ndarray. - - Parameters - ---------- - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran-style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle indices which exceed array dimensions. If equal - to 'throw', an ndarray instance throws an error when an index exceeds - array dimensions. If equal to 'normalize', an ndarray instance - normalizes negative indices and throws an error when an index exceeds - array dimensions. If equal to 'wrap', an ndarray instance wraps around - indices exceeding array dimensions using modulo arithmetic. If equal to - 'clamp', an ndarray instance sets an index exceeding array dimensions - to either `0` (minimum index) or the maximum index. Default: 'throw'. - - options.submode: Array (optional) - Specifies how to handle subscripts which exceed array dimensions. If a - mode for a corresponding dimension is equal to 'throw', an ndarray - instance throws an error when a subscript exceeds array dimensions. If - equal to 'normalize', an ndarray instance normalizes negative - subscripts and throws an error when a subscript exceeds array - dimensions. If equal to 'wrap', an ndarray instance wraps around - subscripts exceeding array dimensions using modulo arithmetic. If equal - to 'clamp', an ndarray instance sets a subscript exceeding array - dimensions to either `0` (minimum index) or the maximum index. If the - number of modes is less than the number of dimensions, an ndarray - instance recycles modes using modulo arithmetic. - - Default: [ options.mode ]. - - options.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A two-dimensional ndarray. - - Examples - -------- - > var arr = {{alias}}() - - - -{{alias}}( shape[, options] ) - Returns a two-dimensional single-precision floating-point ndarray having a - specified shape. - - Parameters - ---------- - shape: ArrayLikeObject - Array shape. Must contain exactly two elements. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran-style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle indices which exceed array dimensions. If equal - to 'throw', an ndarray instance throws an error when an index exceeds - array dimensions. If equal to 'normalize', an ndarray instance - normalizes negative indices and throws an error when an index exceeds - array dimensions. If equal to 'wrap', an ndarray instance wraps around - indices exceeding array dimensions using modulo arithmetic. If equal to - 'clamp', an ndarray instance sets an index exceeding array dimensions - to either `0` (minimum index) or the maximum index. Default: 'throw'. - - options.submode: Array (optional) - Specifies how to handle subscripts which exceed array dimensions. If a - mode for a corresponding dimension is equal to 'throw', an ndarray - instance throws an error when a subscript exceeds array dimensions. If - equal to 'normalize', an ndarray instance normalizes negative - subscripts and throws an error when a subscript exceeds array - dimensions. If equal to 'wrap', an ndarray instance wraps around - subscripts exceeding array dimensions using modulo arithmetic. If equal - to 'clamp', an ndarray instance sets a subscript exceeding array - dimensions to either `0` (minimum index) or the maximum index. If the - number of modes is less than the number of dimensions, an ndarray - instance recycles modes using modulo arithmetic. - - Default: [ options.mode ]. - - options.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A two-dimensional ndarray. - - Examples - -------- - > var arr = {{alias}}( [ 2, 2 ] ) - - - -{{alias}}( M, N[, options] ) - Returns a two-dimensional single-precision floating-point ndarray having a - specified shape. - - Parameters - ---------- - M: integer - Number of rows. - - N: integer - Number of columns. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran-style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle indices which exceed array dimensions. If equal - to 'throw', an ndarray instance throws an error when an index exceeds - array dimensions. If equal to 'normalize', an ndarray instance - normalizes negative indices and throws an error when an index exceeds - array dimensions. If equal to 'wrap', an ndarray instance wraps around - indices exceeding array dimensions using modulo arithmetic. If equal to - 'clamp', an ndarray instance sets an index exceeding array dimensions - to either `0` (minimum index) or the maximum index. Default: 'throw'. - - options.submode: Array (optional) - Specifies how to handle subscripts which exceed array dimensions. If a - mode for a corresponding dimension is equal to 'throw', an ndarray - instance throws an error when a subscript exceeds array dimensions. If - equal to 'normalize', an ndarray instance normalizes negative - subscripts and throws an error when a subscript exceeds array - dimensions. If equal to 'wrap', an ndarray instance wraps around - subscripts exceeding array dimensions using modulo arithmetic. If equal - to 'clamp', an ndarray instance sets a subscript exceeding array - dimensions to either `0` (minimum index) or the maximum index. If the - number of modes is less than the number of dimensions, an ndarray - instance recycles modes using modulo arithmetic. - - Default: [ options.mode ]. - - options.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A two-dimensional ndarray. - - Examples - -------- - > var arr = {{alias}}( 2, 2 ) - - - -{{alias}}( obj[, options] ) - Creates a two-dimensional single-precision floating-point ndarray from an - array-like object or iterable. - - Parameters - ---------- - obj: Object - Array-like object or iterable from which to generate an ndarray. If an - array-like object, the value must be a nested array (i.e., an array-like - object of array-like objects), where each nested array must have the - same number of elements. If an iterable, the iterable must return array- - like objects, each of which must have the same number of elements. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran-style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle indices which exceed array dimensions. If equal - to 'throw', an ndarray instance throws an error when an index exceeds - array dimensions. If equal to 'normalize', an ndarray instance - normalizes negative indices and throws an error when an index exceeds - array dimensions. If equal to 'wrap', an ndarray instance wraps around - indices exceeding array dimensions using modulo arithmetic. If equal to - 'clamp', an ndarray instance sets an index exceeding array dimensions - to either `0` (minimum index) or the maximum index. Default: 'throw'. - - options.submode: Array (optional) - Specifies how to handle subscripts which exceed array dimensions. If a - mode for a corresponding dimension is equal to 'throw', an ndarray - instance throws an error when a subscript exceeds array dimensions. If - equal to 'normalize', an ndarray instance normalizes negative - subscripts and throws an error when a subscript exceeds array - dimensions. If equal to 'wrap', an ndarray instance wraps around - subscripts exceeding array dimensions using modulo arithmetic. If equal - to 'clamp', an ndarray instance sets a subscript exceeding array - dimensions to either `0` (minimum index) or the maximum index. If the - number of modes is less than the number of dimensions, an ndarray - instance recycles modes using modulo arithmetic. - - Default: [ options.mode ]. - - options.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A two-dimensional ndarray. - - Examples - -------- - > var v = [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]; - > var arr = {{alias}}( v ) - - - -{{alias}}( buffer[, byteOffset[, shape]][, options] ) - Returns a two-dimensional single-precision floating-point ndarray view of an - ArrayBuffer. - - Parameters - ---------- - buffer: ArrayBuffer - Underlying ArrayBuffer. - - byteOffset: integer (optional) - Integer byte offset specifying the location of the first indexed - element. Default: 0. - - shape: ArrayLikeObject (optional) - Array shape. Must contain exactly two elements. If not provided, the - view spans from the byteOffset to the end of the underlying ArrayBuffer - and the first dimension of the returned ndarray has a size of one. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran-style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle indices which exceed array dimensions. If equal - to 'throw', an ndarray instance throws an error when an index exceeds - array dimensions. If equal to 'normalize', an ndarray instance - normalizes negative indices and throws an error when an index exceeds - array dimensions. If equal to 'wrap', an ndarray instance wraps around - indices exceeding array dimensions using modulo arithmetic. If equal to - 'clamp', an ndarray instance sets an index exceeding array dimensions - to either `0` (minimum index) or the maximum index. Default: 'throw'. - - options.submode: Array (optional) - Specifies how to handle subscripts which exceed array dimensions. If a - mode for a corresponding dimension is equal to 'throw', an ndarray - instance throws an error when a subscript exceeds array dimensions. If - equal to 'normalize', an ndarray instance normalizes negative - subscripts and throws an error when a subscript exceeds array - dimensions. If equal to 'wrap', an ndarray instance wraps around - subscripts exceeding array dimensions using modulo arithmetic. If equal - to 'clamp', an ndarray instance sets a subscript exceeding array - dimensions to either `0` (minimum index) or the maximum index. If the - number of modes is less than the number of dimensions, an ndarray - instance recycles modes using modulo arithmetic. - - Default: [ options.mode ]. - - options.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A two-dimensional ndarray. - - Examples - -------- - > var buf = new {{alias:@stdlib/array/buffer}}( 32 ); - > var arr = {{alias}}( buf, 0, [ 8, 1 ] ) - - - -{{alias}}( buffer[, byteOffset[, M, N]][, options] ) - Returns a two-dimensional single-precision floating-point ndarray view of an - ArrayBuffer. - - If `M` and `N` are not provided, the returned ndarray view spans from the - byteOffset to the end of the underlying ArrayBuffer. - - Parameters - ---------- - buffer: ArrayBuffer - Underlying ArrayBuffer. - - byteOffset: integer (optional) - Integer byte offset specifying the location of the first indexed - element. Default: 0. - - M: integer (optional) - Number of rows. - - N: integer (optional) - Number of columns. - - options: Object (optional) - Options. - - options.order: string (optional) - Specifies whether an array is row-major (C-style) or column-major - (Fortran-style). Default: 'row-major'. - - options.mode: string (optional) - Specifies how to handle indices which exceed array dimensions. If equal - to 'throw', an ndarray instance throws an error when an index exceeds - array dimensions. If equal to 'normalize', an ndarray instance - normalizes negative indices and throws an error when an index exceeds - array dimensions. If equal to 'wrap', an ndarray instance wraps around - indices exceeding array dimensions using modulo arithmetic. If equal to - 'clamp', an ndarray instance sets an index exceeding array dimensions - to either `0` (minimum index) or the maximum index. Default: 'throw'. - - options.submode: Array (optional) - Specifies how to handle subscripts which exceed array dimensions. If a - mode for a corresponding dimension is equal to 'throw', an ndarray - instance throws an error when a subscript exceeds array dimensions. If - equal to 'normalize', an ndarray instance normalizes negative - subscripts and throws an error when a subscript exceeds array - dimensions. If equal to 'wrap', an ndarray instance wraps around - subscripts exceeding array dimensions using modulo arithmetic. If equal - to 'clamp', an ndarray instance sets a subscript exceeding array - dimensions to either `0` (minimum index) or the maximum index. If the - number of modes is less than the number of dimensions, an ndarray - instance recycles modes using modulo arithmetic. - - Default: [ options.mode ]. - - options.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A two-dimensional ndarray. - - Examples - -------- - > var buf = new {{alias:@stdlib/array/buffer}}( 32 ); - > var arr = {{alias}}( buf, 0, 4, 1 ) - - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 0e6cc3d..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,100 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2026 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 ArrayBuffer = require( '@stdlib/array-buffer' ); -import Float32Matrix = require( './index' ); - - -// TESTS // - -// The function returns an ndarray... -{ - new Float32Matrix(); // $ExpectType float32ndarray - new Float32Matrix( {} ); // $ExpectType float32ndarray - - new Float32Matrix( 10, 10 ); // $ExpectType float32ndarray - new Float32Matrix( 10, 10, {} ); // $ExpectType float32ndarray - - new Float32Matrix( [ 10, 10 ] ); // $ExpectType float32ndarray - new Float32Matrix( [ 10, 10 ], {} ); // $ExpectType float32ndarray - - new Float32Matrix( [ [ 1, 2 ], [ 3, 4 ] ] ); // $ExpectType float32ndarray - new Float32Matrix( [ [ 1, 2 ], [ 3, 4 ] ], {} ); // $ExpectType float32ndarray - - new Float32Matrix( new ArrayBuffer( 10 ) ); // $ExpectType float32ndarray - new Float32Matrix( new ArrayBuffer( 10 ), {} ); // $ExpectType float32ndarray - - new Float32Matrix( new ArrayBuffer( 10 ), 8 ); // $ExpectType float32ndarray - new Float32Matrix( new ArrayBuffer( 10 ), 8, {} ); // $ExpectType float32ndarray - - new Float32Matrix( new ArrayBuffer( 10 ), 8, [ 1, 1 ] ); // $ExpectType float32ndarray - new Float32Matrix( new ArrayBuffer( 10 ), 8, [ 1, 1 ], {} ); // $ExpectType float32ndarray - - new Float32Matrix( new ArrayBuffer( 10 ), 8, 1, 1 ); // $ExpectType float32ndarray - new Float32Matrix( new ArrayBuffer( 10 ), 8, 1, 1, {} ); // $ExpectType float32ndarray - - const matrix = Float32Matrix; - matrix(); // $ExpectType float32ndarray - matrix( {} ); // $ExpectType float32ndarray - - matrix( 10, 10 ); // $ExpectType float32ndarray - matrix( 10, 10, {} ); // $ExpectType float32ndarray - - matrix( [ 10, 10 ] ); // $ExpectType float32ndarray - matrix( [ 10, 10 ], {} ); // $ExpectType float32ndarray - - matrix( [ [ 1, 2 ], [ 3, 4 ] ] ); // $ExpectType float32ndarray - matrix( [ [ 1, 2 ], [ 3, 4 ] ], {} ); // $ExpectType float32ndarray - - matrix( new ArrayBuffer( 10 ) ); // $ExpectType float32ndarray - matrix( new ArrayBuffer( 10 ), {} ); // $ExpectType float32ndarray - - matrix( new ArrayBuffer( 10 ), 8 ); // $ExpectType float32ndarray - matrix( new ArrayBuffer( 10 ), 8, {} ); // $ExpectType float32ndarray - - matrix( new ArrayBuffer( 10 ), 8, [ 1, 1 ] ); // $ExpectType float32ndarray - matrix( new ArrayBuffer( 10 ), 8, [ 1, 1 ], {} ); // $ExpectType float32ndarray - - matrix( new ArrayBuffer( 10 ), 8, 1, 1 ); // $ExpectType float32ndarray - matrix( new ArrayBuffer( 10 ), 8, 1, 1, {} ); // $ExpectType float32ndarray -} - -// The compiler throws an error if the function is provided a first argument which is not a number, array-like object, iterable, or options object... -{ - new Float32Matrix( true ); // $ExpectError - new Float32Matrix( false ); // $ExpectError - new Float32Matrix( null ); // $ExpectError - new Float32Matrix( ( x: number ): number => x ); // $ExpectError - - const matrix = Float32Matrix; - matrix( true ); // $ExpectError - matrix( false ); // $ExpectError - matrix( null ); // $ExpectError - matrix( ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const buf = new ArrayBuffer( 32 ); - new Float32Matrix( buf, 8, 2, 1, {}, {} ); // $ExpectError - new Float32Matrix( buf, 8, [ 2, 1 ], {}, {} ); // $ExpectError - - const matrix = Float32Matrix; - matrix( buf, 8, 2, 1, {}, {} ); // $ExpectError - matrix( buf, 8, [ 2, 1 ], {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index ca82258..0000000 --- a/examples/index.js +++ /dev/null @@ -1,51 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2026 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -var discreteUniform = require( '@stdlib/random-array-discrete-uniform' ); -var sum = require( '@stdlib/blas-ext-sum' ); -var map = require( '@stdlib/ndarray-map' ); -var ndarray2array = require( '@stdlib/ndarray-to-array' ); -var Float32Matrix = require( './../lib' ); - -// Create a matrix containing random values: -var x = new Float32Matrix([ - discreteUniform( 10, 0, 100 ), - discreteUniform( 10, 0, 20 ) -]); - -// Compute the sum along the columns: -var v = sum( x, { - 'dims': [ -1 ] -}); -console.log( ndarray2array( v ) ); - -// Define a function which applies a threshold to individual values: -function threshold( v ) { - return ( v > 10 ) ? v : 0; -} - -// Apply threshold: -var y = map( x, threshold ); - -// Recompute the sum along the columns: -v = sum( y, { - 'dims': [ -1 ] -}); -console.log( ndarray2array( v ) ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 99% rename from docs/types/index.d.ts rename to index.d.ts index 5d30fac..fb5eb97 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -20,7 +20,7 @@ /* eslint-disable @typescript-eslint/unified-signatures */ -/// +/// import { Order, Mode, float32ndarray, Shape2D } from '@stdlib/types/ndarray'; import { Collection, AccessorArrayLike, ArrayLike } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..d687205 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import{factory as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-matrix-ctor@esm/index.mjs";var r=t("float32");export{r as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..1fc582f --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/main.js"],"sourcesContent":["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2026 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* 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 as factory } from '@stdlib/ndarray-matrix-ctor';\n\n\n// MAIN //\n\n/**\n* Returns a single-precision floating-point matrix (i.e., a two-dimensional ndarray).\n*\n* @name Float32Matrix\n* @type {Function}\n* @param {(NonNegativeInteger|NonNegativeIntegerArray|ArrayLikeObject|ArrayBuffer|Iterable)} [arg0] - shape, number of rows, array-like object, ArrayBuffer, or iterable\n* @param {NonNegativeInteger} [arg1] - number of columns or byte offset\n* @param {(NonNegativeInteger|NonNegativeIntegerArray)} [arg2] - shape or number of rows\n* @param {NonNegativeInteger} [arg3] - number of columns\n* @param {Options} [options] - function options\n* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only matrix\n* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed matrix dimensions\n* @param {StringArray} [options.submode=[options.mode]] - specifies how to handle subscripts which exceed array dimensions on a per dimension basis\n* @param {string} [options.order='row-major'] - memory layout (either row-major or column-major)\n* @throws {TypeError} first argument must be either a shape, integer, array-like object, ArrayBuffer, iterable, or options object\n* @throws {TypeError} must provide valid options\n* @returns {ndarray} two-dimensional ndarray\n*\n* @example\n* import getShape from '@stdlib/ndarray-shape';\n*\n* var v = new Float32Matrix();\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 0, 0 ]\n*\n* @example\n* import getShape from '@stdlib/ndarray-shape';\n*\n* var v = new Float32Matrix( [ 2, 2 ] );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 2 ]\n*\n* @example\n* import getShape from '@stdlib/ndarray-shape';\n*\n* var v = new Float32Matrix( 2, 2 );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 2 ]\n*\n* @example\n* import getShape from '@stdlib/ndarray-shape';\n*\n* var v = new Float32Matrix( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 2 ]\n*\n* @example\n* import ArrayBuffer from '@stdlib/array-buffer';\n* import getShape from '@stdlib/ndarray-shape';\n*\n* var buf = new ArrayBuffer( 32 );\n* var v = new Float32Matrix( buf );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 1, 8 ]\n*\n* @example\n* import ArrayBuffer from '@stdlib/array-buffer';\n* import getShape from '@stdlib/ndarray-shape';\n*\n* var buf = new ArrayBuffer( 32 );\n* var v = new Float32Matrix( buf, 16 );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 1, 4 ]\n*\n* @example\n* import ArrayBuffer from '@stdlib/array-buffer';\n* import getShape from '@stdlib/ndarray-shape';\n*\n* var buf = new ArrayBuffer( 64 );\n* var v = new Float32Matrix( buf, 16, [ 2, 1 ] );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 1 ]\n*\n* @example\n* import ArrayBuffer from '@stdlib/array-buffer';\n* import getShape from '@stdlib/ndarray-shape';\n*\n* var buf = new ArrayBuffer( 64 );\n* var v = new Float32Matrix( buf, 16, 2, 1 );\n* // returns \n*\n* var len = getShape( v );\n* // returns [ 2, 1 ]\n*/\nvar Float32Matrix = factory( 'float32' );\n\n\n// EXPORTS //\n\nexport default Float32Matrix;\n"],"names":["Float32Matrix","factory"],"mappings":";;kGA6HG,IAACA,EAAgBC,EAAS"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index b62f3e6..0000000 --- a/lib/index.js +++ /dev/null @@ -1,122 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2026 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 a single-precision floating-point matrix (i.e., a two-dimensional ndarray). -* -* @module @stdlib/ndarray-matrix-float32 -* -* @example -* var getShape = require( '@stdlib/ndarray-shape' ); -* var Float32Matrix = require( '@stdlib/ndarray-matrix-float32' ); -* -* var v = new Float32Matrix(); -* // returns -* -* var len = getShape( v ); -* // returns [ 0, 0 ] -* -* @example -* var getShape = require( '@stdlib/ndarray-shape' ); -* var Float32Matrix = require( '@stdlib/ndarray-matrix-float32' ); -* -* var v = new Float32Matrix( [ 2, 2 ] ); -* // returns -* -* var len = getShape( v ); -* // returns [ 2, 2 ] -* -* @example -* var getShape = require( '@stdlib/ndarray-shape' ); -* var Float32Matrix = require( '@stdlib/ndarray-matrix-float32' ); -* -* var v = new Float32Matrix( 2, 2 ); -* // returns -* -* var len = getShape( v ); -* // returns [ 2, 2 ] -* -* @example -* var getShape = require( '@stdlib/ndarray-shape' ); -* var Float32Matrix = require( '@stdlib/ndarray-matrix-float32' ); -* -* var v = new Float32Matrix( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ); -* // returns -* -* var len = getShape( v ); -* // returns [ 2, 2 ] -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var getShape = require( '@stdlib/ndarray-shape' ); -* var Float32Matrix = require( '@stdlib/ndarray-matrix-float32' ); -* -* var buf = new ArrayBuffer( 32 ); -* var v = new Float32Matrix( buf ); -* // returns -* -* var len = getShape( v ); -* // returns [ 1, 8 ] -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var getShape = require( '@stdlib/ndarray-shape' ); -* var Float32Matrix = require( '@stdlib/ndarray-matrix-float32' ); -* -* var buf = new ArrayBuffer( 32 ); -* var v = new Float32Matrix( buf, 16 ); -* // returns -* -* var len = getShape( v ); -* // returns [ 1, 4 ] -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var getShape = require( '@stdlib/ndarray-shape' ); -* var Float32Matrix = require( '@stdlib/ndarray-matrix-float32' ); -* -* var buf = new ArrayBuffer( 64 ); -* var v = new Float32Matrix( buf, 16, [ 2, 1 ] ); -* // returns -* -* var len = getShape( v ); -* // returns [ 2, 1 ] -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var getShape = require( '@stdlib/ndarray-shape' ); -* var Float32Matrix = require( '@stdlib/ndarray-matrix-float32' ); -* -* var buf = new ArrayBuffer( 64 ); -* var v = new Float32Matrix( buf, 16, 2, 1 ); -* // returns -* -* var len = getShape( v ); -* // returns [ 2, 1 ] -*/ - -// MODULES // - -var main = require( './main.js' ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index a1e2693..0000000 --- a/lib/main.js +++ /dev/null @@ -1,131 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2026 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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( '@stdlib/ndarray-matrix-ctor' ).factory; - - -// MAIN // - -/** -* Returns a single-precision floating-point matrix (i.e., a two-dimensional ndarray). -* -* @name Float32Matrix -* @type {Function} -* @param {(NonNegativeInteger|NonNegativeIntegerArray|ArrayLikeObject|ArrayBuffer|Iterable)} [arg0] - shape, number of rows, array-like object, ArrayBuffer, or iterable -* @param {NonNegativeInteger} [arg1] - number of columns or byte offset -* @param {(NonNegativeInteger|NonNegativeIntegerArray)} [arg2] - shape or number of rows -* @param {NonNegativeInteger} [arg3] - number of columns -* @param {Options} [options] - function options -* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only matrix -* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed matrix dimensions -* @param {StringArray} [options.submode=[options.mode]] - specifies how to handle subscripts which exceed array dimensions on a per dimension basis -* @param {string} [options.order='row-major'] - memory layout (either row-major or column-major) -* @throws {TypeError} first argument must be either a shape, integer, array-like object, ArrayBuffer, iterable, or options object -* @throws {TypeError} must provide valid options -* @returns {ndarray} two-dimensional ndarray -* -* @example -* var getShape = require( '@stdlib/ndarray-shape' ); -* -* var v = new Float32Matrix(); -* // returns -* -* var len = getShape( v ); -* // returns [ 0, 0 ] -* -* @example -* var getShape = require( '@stdlib/ndarray-shape' ); -* -* var v = new Float32Matrix( [ 2, 2 ] ); -* // returns -* -* var len = getShape( v ); -* // returns [ 2, 2 ] -* -* @example -* var getShape = require( '@stdlib/ndarray-shape' ); -* -* var v = new Float32Matrix( 2, 2 ); -* // returns -* -* var len = getShape( v ); -* // returns [ 2, 2 ] -* -* @example -* var getShape = require( '@stdlib/ndarray-shape' ); -* -* var v = new Float32Matrix( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ); -* // returns -* -* var len = getShape( v ); -* // returns [ 2, 2 ] -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var getShape = require( '@stdlib/ndarray-shape' ); -* -* var buf = new ArrayBuffer( 32 ); -* var v = new Float32Matrix( buf ); -* // returns -* -* var len = getShape( v ); -* // returns [ 1, 8 ] -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var getShape = require( '@stdlib/ndarray-shape' ); -* -* var buf = new ArrayBuffer( 32 ); -* var v = new Float32Matrix( buf, 16 ); -* // returns -* -* var len = getShape( v ); -* // returns [ 1, 4 ] -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var getShape = require( '@stdlib/ndarray-shape' ); -* -* var buf = new ArrayBuffer( 64 ); -* var v = new Float32Matrix( buf, 16, [ 2, 1 ] ); -* // returns -* -* var len = getShape( v ); -* // returns [ 2, 1 ] -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var getShape = require( '@stdlib/ndarray-shape' ); -* -* var buf = new ArrayBuffer( 64 ); -* var v = new Float32Matrix( buf, 16, 2, 1 ); -* // returns -* -* var len = getShape( v ); -* // returns [ 2, 1 ] -*/ -var Float32Matrix = factory( 'float32' ); - - -// EXPORTS // - -module.exports = Float32Matrix; diff --git a/package.json b/package.json index d6f3604..fe36b21 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.0.0", "description": "Create a single-precision floating-point matrix (i.e., a two-dimensional ndarray).", "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,47 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/ndarray-matrix-ctor": "github:stdlib-js/ndarray-matrix-ctor#main", - "@stdlib/types": "^0.5.1" - }, - "devDependencies": { - "@stdlib/array-buffer": "^0.2.3", - "@stdlib/array-float32": "^0.2.3", - "@stdlib/assert-is-ndarray-like": "^0.2.3", - "@stdlib/assert-is-ndarray-like-with-data-type": "^0.1.1", - "@stdlib/assert-is-same-float32array": "^0.2.3", - "@stdlib/blas-ext-sum": "^0.1.1", - "@stdlib/math-base-special-floor": "^0.2.4", - "@stdlib/math-base-special-pow": "^0.3.1", - "@stdlib/ndarray-base-assert-is-read-only": "^0.2.3", - "@stdlib/ndarray-data-buffer": "^0.2.3", - "@stdlib/ndarray-map": "^0.1.1", - "@stdlib/ndarray-order": "^0.2.3", - "@stdlib/ndarray-shape": "^0.2.3", - "@stdlib/ndarray-to-array": "^0.2.2", - "@stdlib/random-array-discrete-uniform": "^0.2.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.3", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.3" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..0807e84 --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 65fdf78..0000000 --- a/test/test.js +++ /dev/null @@ -1,1394 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2026 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable no-new */ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var isndarrayLikeWithDataType = require( '@stdlib/assert-is-ndarray-like-with-data-type' ); -var isSameFloat32Array = require( '@stdlib/assert-is-same-float32array' ); -var isReadOnly = require( '@stdlib/ndarray-base-assert-is-read-only' ); -var ArrayBuffer = require( '@stdlib/array-buffer' ); -var Float32Array = require( '@stdlib/array-float32' ); -var getData = require( '@stdlib/ndarray-data-buffer' ); -var getShape = require( '@stdlib/ndarray-shape' ); -var getOrder = require( '@stdlib/ndarray-order' ); -var Float32Matrix = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof Float32Matrix, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if provided an invalid first argument', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1 ], - [ 1, 2, 3 ], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1 ], - [ 1, 2, 3 ], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( value, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (second argument)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( value, 0 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (second argument, options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( value, 0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (byteoffset, shape)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( value, 0, [ 0, 0 ] ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (byteoffset, shape, options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( value, 0, [ 0, 0 ], {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (byteoffset, M, N)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( value, 0, 0, 0 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (byteoffset, M, N, options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( value, 0, 0, 0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid byte offset argument', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( new ArrayBuffer( 8 ), value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid byte offset argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( new ArrayBuffer( 8 ), value, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid byte offset argument (shape)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( new ArrayBuffer( 8 ), value, [ 1, 1 ] ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid byte offset argument (shape, options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( new ArrayBuffer( 8 ), value, [ 1, 1 ], {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid byte offset argument (M, N)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( new ArrayBuffer( 8 ), value, 1, 1 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid byte offset argument (M, N, options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( new ArrayBuffer( 8 ), value, 1, 1, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid shape argument', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1 ], - [ 1, 1, 1 ], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( new ArrayBuffer( 8 ), 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid shape argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1 ], - [ 1, 1, 1 ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( new ArrayBuffer( 8 ), 0, value, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid `M` argument', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1 ], - [ 1, 1, 1 ], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( new ArrayBuffer( 8 ), 0, value, 1 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid `M` argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1 ], - [ 1, 1, 1 ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( new ArrayBuffer( 8 ), 0, value, 1, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid `N` argument', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1 ], - [ 1, 1, 1 ], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( new ArrayBuffer( 8 ), 0, 1, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid `N` argument (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - 3.14, - NaN, - true, - false, - null, - void 0, - [], - [ 1 ], - [ 1, 1, 1 ], - {}, - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( new ArrayBuffer( 8 ), 0, 1, value, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (shape)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( [ 3, 3 ], value ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (M, N)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( 3, 3, value ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (array)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ], value ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (arraybuffer)', function test( t ) { - var values; - var i; - - values = [ - '5', - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( new ArrayBuffer( 8 ), value ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (arraybuffer, byteoffset)', function test( t ) { - var values; - var i; - - values = [ - '5', - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( new ArrayBuffer( 8 ), 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (arraybuffer, byteoffset, shape)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( new ArrayBuffer( 8 ), 0, [ 1, 1 ], value ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (arraybuffer, byteoffset, M, N)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - [], - function noop() {} - ]; - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix( new ArrayBuffer( 8 ), 0, 1, 1, value ); - }; - } -}); - -tape( 'the function throws an error if provided an `order` option which is not a recognized order', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'ROW', - 'row', - 'col-major', - 'col', - 'major', - 'minor', - null - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix({ - 'order': value - }); - }; - } -}); - -tape( 'the function throws an error if provided a `mode` option which is not a recognized mode', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'THROW', - 5, - null, - true, - false, - [], - {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix({ - 'mode': value - }); - }; - } -}); - -tape( 'the function throws an error if provided a `mode` option which is not a recognized submode', function test( t ) { - var values; - var i; - - values = [ - '5', - 'beep', - 'THROW', - 5, - null, - true, - false, - [], - {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix({ - 'submode': [ value ] - }); - }; - } -}); - -tape( 'the function throws an error if provided a `readonly` option which is not a boolean', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - null, - void 0, - [], - {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - new Float32Matrix({ - 'readonly': value - }); - }; - } -}); - -tape( 'the function returns a two-dimensional ndarray', function test( t ) { - var arr; - - arr = new Float32Matrix(); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 0, 0 ], 'returns expected value' ); - - arr = new Float32Matrix( {} ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 0, 0 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a two-dimensional ndarray (shape)', function test( t ) { - var arr; - - arr = new Float32Matrix( [ 3, 3 ] ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 3, 3 ], 'returns expected value' ); - - arr = new Float32Matrix( [ 3, 3 ], {} ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 3, 3 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a two-dimensional ndarray (M, N)', function test( t ) { - var arr; - - arr = new Float32Matrix( 3, 3 ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 3, 3 ], 'returns expected value' ); - - arr = new Float32Matrix( 3, 3, {} ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 3, 3 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a two-dimensional ndarray (array)', function test( t ) { - var arr; - var out; - - arr = [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ]; - - out = new Float32Matrix( arr ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( out ), [ 2, 2 ], 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( [ 1.0, 2.0, 3.0, 4.0 ] ) ), true, 'returns expected value' ); - - out = new Float32Matrix( arr, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( out ), [ 2, 2 ], 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( [ 1.0, 2.0, 3.0, 4.0 ] ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a two-dimensional ndarray (arraybuffer)', function test( t ) { - var buf; - var out; - - buf = new ArrayBuffer( 16 ); - - out = new Float32Matrix( buf ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( out ), [ 1, 4 ], 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf ) ), true, 'returns expected value' ); - - out = new Float32Matrix( buf, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( out ), [ 1, 4 ], 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a two-dimensional ndarray (arraybuffer, byteoffset)', function test( t ) { - var buf; - var out; - - buf = new ArrayBuffer( 64 ); - - out = new Float32Matrix( buf, 8 ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( out ), [ 1, 14 ], 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf, 8 ) ), true, 'returns expected value' ); - - out = new Float32Matrix( buf, 8, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( out ), [ 1, 14 ], 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf, 8 ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a two-dimensional ndarray (arraybuffer, byteoffset, shape)', function test( t ) { - var buf; - var out; - - buf = new ArrayBuffer( 64 ); - - out = new Float32Matrix( buf, 8, [ 2, 1 ] ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( out ), [ 2, 1 ], 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf, 8, 2 ) ), true, 'returns expected value' ); - - out = new Float32Matrix( buf, 8, [ 2, 1 ], {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( out ), [ 2, 1 ], 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf, 8, 2 ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a two-dimensional ndarray (arraybuffer, byteoffset, M, N)', function test( t ) { - var buf; - var out; - - buf = new ArrayBuffer( 64 ); - - out = new Float32Matrix( buf, 8, 2, 1 ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( out ), [ 2, 1 ], 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf, 8, 2 ) ), true, 'returns expected value' ); - - out = new Float32Matrix( buf, 8, 2, 1, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( out ), [ 2, 1 ], 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf, 8, 2 ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout', function test( t ) { - var arr; - - arr = new Float32Matrix({ - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 0, 0 ], 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Float32Matrix({ - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 0, 0 ], 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (shape)', function test( t ) { - var arr; - - arr = new Float32Matrix( [ 3, 3 ], { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 3, 3 ], 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Float32Matrix( [ 3, 3 ], { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 3, 3 ], 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (array)', function test( t ) { - var arr; - - arr = new Float32Matrix( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ], { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 2, 2 ], 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Float32Matrix( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ], { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 2, 2 ], 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (arraybuffer)', function test( t ) { - var arr; - - arr = new Float32Matrix( new ArrayBuffer( 64 ), { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 1, 16 ], 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Float32Matrix( new ArrayBuffer( 64 ), { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 1, 16 ], 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (arraybuffer, byteoffset)', function test( t ) { - var arr; - - arr = new Float32Matrix( new ArrayBuffer( 64 ), 8, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 1, 14 ], 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Float32Matrix( new ArrayBuffer( 64 ), 8, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 1, 14 ], 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (arraybuffer, byteoffset, shape)', function test( t ) { - var arr; - - arr = new Float32Matrix( new ArrayBuffer( 64 ), 8, [ 2, 1 ], { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 2, 1 ], 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Float32Matrix( new ArrayBuffer( 64 ), 8, [ 2, 1 ], { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 2, 1 ], 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (arraybuffer, byteoffset, M, N)', function test( t ) { - var arr; - - arr = new Float32Matrix( new ArrayBuffer( 64 ), 8, 2, 1, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 2, 1 ], 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Float32Matrix( new ArrayBuffer( 64 ), 8, 2, 1, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 2, 1 ], 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning read-only ndarrays', function test( t ) { - var arr; - - arr = new Float32Matrix({ - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 0, 0 ], 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning read-only ndarrays (shape)', function test( t ) { - var arr; - - arr = new Float32Matrix( [ 3, 3 ], { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 3, 3 ], 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning read-only ndarrays (array)', function test( t ) { - var arr; - - arr = new Float32Matrix( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ], { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 2, 2 ], 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning read-only ndarrays (arraybuffer)', function test( t ) { - var arr; - - arr = new Float32Matrix( new ArrayBuffer( 64 ), { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 1, 16 ], 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning read-only ndarrays (arraybuffer, byteoffset)', function test( t ) { - var arr; - - arr = new Float32Matrix( new ArrayBuffer( 64 ), 8, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 1, 14 ], 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning read-only ndarrays (arraybuffer, byteoffset, shape)', function test( t ) { - var arr; - - arr = new Float32Matrix( new ArrayBuffer( 64 ), 8, [ 2, 1 ], { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 2, 1 ], 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning read-only ndarrays (arraybuffer, byteoffset, M, N)', function test( t ) { - var arr; - - arr = new Float32Matrix( new ArrayBuffer( 64 ), 8, 2, 1, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 2, 1 ], 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning writable ndarrays', function test( t ) { - var arr; - - arr = new Float32Matrix({ - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 0, 0 ], 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning writable ndarrays (shape)', function test( t ) { - var arr; - - arr = new Float32Matrix( [ 3, 3 ], { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 3, 3 ], 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning writable ndarrays (array)', function test( t ) { - var arr; - - arr = new Float32Matrix( [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ], { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 2, 2 ], 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning writable ndarrays (arraybuffer)', function test( t ) { - var arr; - - arr = new Float32Matrix( new ArrayBuffer( 64 ), { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 1, 16 ], 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning writable ndarrays (arraybuffer, byteoffset)', function test( t ) { - var arr; - - arr = new Float32Matrix( new ArrayBuffer( 64 ), 8, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 1, 14 ], 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning writable ndarrays (arraybuffer, byteoffset, shape)', function test( t ) { - var arr; - - arr = new Float32Matrix( new ArrayBuffer( 64 ), 8, [ 2, 1 ], { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 2, 1 ], 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning writable ndarrays (arraybuffer, byteoffset, M, N)', function test( t ) { - var arr; - - arr = new Float32Matrix( new ArrayBuffer( 64 ), 8, 2, 1, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.deepEqual( getShape( arr ), [ 2, 1 ], 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -});