From 47cc635ac4b8cd7fb08eb54b6be76cff15ded1c4 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 17 May 2025 09:03:17 +0000 Subject: [PATCH 01/42] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 2bc68eb..dba5161 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/ndarray-vector-ctor": "github:stdlib-js/ndarray-vector-ctor#main", - "@stdlib/types": "^0.4.3" + "@stdlib/types": "^0.4.3", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2" }, "devDependencies": { "@stdlib/array-buffer": "^0.2.2", @@ -91,4 +92,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From a5cc346d30035ebd16c3ad9bccaeeee1fe85091b Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 17 May 2025 09:05:12 +0000 Subject: [PATCH 02/42] Auto-generated commit --- .editorconfig | 180 - .eslintrc.js | 1 - .gitattributes | 66 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 794 --- .github/workflows/publish.yml | 252 - .github/workflows/test.yml | 99 - .github/workflows/test_bundles.yml | 186 - .github/workflows/test_coverage.yml | 133 - .github/workflows/test_install.yml | 85 - .github/workflows/test_published_package.yml | 105 - .gitignore | 194 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 48 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 55 +- SECURITY.md | 5 - benchmark/benchmark.js | 47 - benchmark/benchmark.size.js | 93 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 175 - docs/types/test.ts | 86 - examples/index.js | 43 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 100 - lib/main.js | 109 - package.json | 68 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 1022 ---- 44 files changed, 4874 insertions(+), 5213 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 dab5d2a..0000000 --- a/.editorconfig +++ /dev/null @@ -1,180 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim. - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 1c88e69..0000000 --- a/.gitattributes +++ /dev/null @@ -1,66 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index a8a68fb..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/vector/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 f21cc2e..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/vector/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 d88538c..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: '0 0 * * 3' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index f4575e9..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,794 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA - uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 - with: - status: ${{ job.status }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -225,7 +216,7 @@ console.log( v.get() ); ## 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]. @@ -288,9 +279,9 @@ Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-vector-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 7418c03..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,47 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* 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 Float32Vector = require( './../lib' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var arr; - var i; - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr = new Float32Vector( 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 46056e3..0000000 --- a/benchmark/benchmark.size.js +++ /dev/null @@ -1,93 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* 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 isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var pkg = require( './../package.json' ).name; -var Float32Vector = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var arr; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr = new Float32Vector( len ); - if ( arr.length !== len ) { - b.fail( 'unexpected length' ); - } - } - 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 len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':size='+len, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 6d01049..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/vector/float32" -%% click B href "https://github.com/stdlib-js/ndarray-vector-float32/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-vector-float32/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-vector-float32/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-vector-float32/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-vector-float32/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/vector/float32 -[production-url]: https://github.com/stdlib-js/ndarray-vector-float32/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-vector-float32/tree/deno -[deno-readme]: https://github.com/stdlib-js/ndarray-vector-float32/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/ndarray-vector-float32/tree/umd -[umd-readme]: https://github.com/stdlib-js/ndarray-vector-float32/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/ndarray-vector-float32/tree/esm -[esm-readme]: https://github.com/stdlib-js/ndarray-vector-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 7c5ecb1..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var o=function(a,r){return function(){return r||a((r={exports:{}}).exports,r),r.exports}};var e=o(function(f,t){ -var s=require('@stdlib/ndarray-vector-ctor/dist').factory,c=s("float32");t.exports=c -});var i=e();module.exports=i; -/** @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 a14f526..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) 2025 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* 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-vector-ctor' ).factory;\n\n\n// MAIN //\n\n/**\n* Returns a single-precision floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Float32Vector\n* @type {Function}\n* @param {(NonNegativeInteger|Collection|ArrayBuffer|Iterable)} [arg] - length, typed array, array-like object, buffer, or iterable\n* @param {NonNegativeInteger} [byteOffset=0] - byte offset\n* @param {NonNegativeInteger} [length] - view length\n* @param {Options} [options] - function options\n* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only vector\n* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed vector dimensions\n* @param {string} [options.order='row-major'] - memory layout (either row-major or column-major)\n* @throws {TypeError} first argument must be either a length, typed array, array-like object, buffer, iterable, or options object\n* @throws {TypeError} must provide valid options\n* @returns {ndarray} one-dimensional ndarray\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n*\n* var arr = new Float32Vector();\n* // returns \n*\n* var len = numel( arr );\n* // returns 0\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n*\n* var arr = new Float32Vector( 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n*\n* var arr = new Float32Vector( [ 1.0, 2.0 ] );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf );\n* // returns \n*\n* var len = numel( arr );\n* // returns 8\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf, 16 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 4\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n*\n* var buf = new ArrayBuffer( 64 );\n* var arr = new Float32Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Float32Vector = factory( 'float32' );\n\n\n// EXPORTS //\n\nmodule.exports = Float32Vector;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 vector (i.e., a one-dimensional ndarray).\n*\n* @module @stdlib/ndarray-vector-float32\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var v = new Float32Vector();\n* // returns \n*\n* var len = numel( v );\n* // returns 0\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var v = new Float32Vector( 2 );\n* // returns \n*\n* var len = numel( v );\n* // returns 2\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var v = new Float32Vector( [ 1.0, 2.0 ] );\n* // returns \n*\n* var len = numel( v );\n* // returns 2\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var buf = new ArrayBuffer( 32 );\n* var v = new Float32Vector( buf );\n* // returns \n*\n* var len = numel( v );\n* // returns 8\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var buf = new ArrayBuffer( 32 );\n* var v = new Float32Vector( buf, 16 );\n* // returns \n*\n* var len = numel( v );\n* // returns 4\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var buf = new ArrayBuffer( 64 );\n* var v = new Float32Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( v );\n* // returns 2\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,QAAS,6BAA8B,EAAE,QAiFnDC,EAAgBD,EAAS,SAAU,EAKvCD,EAAO,QAAUE,ICdjB,IAAIC,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "factory", "Float32Vector", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index d6ef21a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,175 +0,0 @@ - -{{alias}}( [options] ) - Returns a one-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.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A one-dimensional ndarray. - - Examples - -------- - > var arr = {{alias}}() - - - -{{alias}}( length[, options] ) - Returns a one-dimensional single-precision floating-point ndarray having a - specified length. - - Parameters - ---------- - length: integer - 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.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A one-dimensional ndarray. - - Examples - -------- - > var arr = {{alias}}( 5 ) - - > var len = {{alias:@stdlib/ndarray/numel}}( arr ) - 5 - - -{{alias}}( obj[, options] ) - Creates a one-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. - - 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.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A one-dimensional ndarray. - - Examples - -------- - > var v = [ 1.0, 2.0, 3.0 ]; - > var arr = {{alias}}( v ) - - > var len = {{alias:@stdlib/ndarray/numel}}( arr ) - 3 - - -{{alias}}( buffer[, byteOffset[, length]][, options] ) - Returns a one-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. - - length: integer (optional) - View length. If not provided, the view spans from the byteOffset to - the end of the underlying ArrayBuffer. - - 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.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A one-dimensional ndarray. - - Examples - -------- - > var buf = new {{alias:@stdlib/array/buffer}}( 16 ); - > var arr = {{alias}}( buf, 0, 4 ) - - > var len = {{alias:@stdlib/ndarray/numel}}( arr ) - 4 - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index c222353..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,86 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 Float32Vector = require( './index' ); - - -// TESTS // - -// The function returns an ndarray... -{ - new Float32Vector(); // $ExpectType float32ndarray - new Float32Vector( {} ); // $ExpectType float32ndarray - - new Float32Vector( 10 ); // $ExpectType float32ndarray - new Float32Vector( 10, {} ); // $ExpectType float32ndarray - - new Float32Vector( [ 1, 2, 3 ] ); // $ExpectType float32ndarray - new Float32Vector( [ 1, 2, 3 ], {} ); // $ExpectType float32ndarray - - new Float32Vector( new ArrayBuffer( 10 ) ); // $ExpectType float32ndarray - new Float32Vector( new ArrayBuffer( 10 ), {} ); // $ExpectType float32ndarray - - new Float32Vector( new ArrayBuffer( 10 ), 8 ); // $ExpectType float32ndarray - new Float32Vector( new ArrayBuffer( 10 ), 8, {} ); // $ExpectType float32ndarray - - new Float32Vector( new ArrayBuffer( 10 ), 8, 0 ); // $ExpectType float32ndarray - new Float32Vector( new ArrayBuffer( 10 ), 8, 0, {} ); // $ExpectType float32ndarray - - const vector = Float32Vector; - vector(); // $ExpectType float32ndarray - vector( {} ); // $ExpectType float32ndarray - - vector( 10 ); // $ExpectType float32ndarray - vector( 10, {} ); // $ExpectType float32ndarray - - vector( [ 1, 2, 3 ] ); // $ExpectType float32ndarray - vector( [ 1, 2, 3 ], {} ); // $ExpectType float32ndarray - - vector( new ArrayBuffer( 10 ) ); // $ExpectType float32ndarray - vector( new ArrayBuffer( 10 ), {} ); // $ExpectType float32ndarray - - vector( new ArrayBuffer( 10 ), 8 ); // $ExpectType float32ndarray - vector( new ArrayBuffer( 10 ), 8, {} ); // $ExpectType float32ndarray - - vector( new ArrayBuffer( 10 ), 8, 0 ); // $ExpectType float32ndarray - vector( new ArrayBuffer( 10 ), 8, 0, {} ); // $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 Float32Vector( true ); // $ExpectError - new Float32Vector( false ); // $ExpectError - new Float32Vector( null ); // $ExpectError - new Float32Vector( ( x: number ): number => x ); // $ExpectError - - const vector = Float32Vector; - vector( true ); // $ExpectError - vector( false ); // $ExpectError - vector( null ); // $ExpectError - vector( ( 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 Float32Vector( buf, 8, 2, {}, {} ); // $ExpectError - - const vector = Float32Vector; - vector( buf, 8, 2, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 24af996..0000000 --- a/examples/index.js +++ /dev/null @@ -1,43 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 Float32Vector = require( './../lib' ); - -// Create a vector containing random values: -var x = new Float32Vector( discreteUniform( 10, 0, 100 ) ); - -// Compute the sum: -var v = sum( x ); -console.log( v.get() ); - -// 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: -v = sum( y ); -console.log( v.get() ); 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 0a146a7..bb39900 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 } from '@stdlib/types/ndarray'; import { Collection, AccessorArrayLike } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..1ff30e9 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2025 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import{factory as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-vector-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..9e33e21 --- /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) 2025 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* 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-vector-ctor';\n\n\n// MAIN //\n\n/**\n* Returns a single-precision floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Float32Vector\n* @type {Function}\n* @param {(NonNegativeInteger|Collection|ArrayBuffer|Iterable)} [arg] - length, typed array, array-like object, buffer, or iterable\n* @param {NonNegativeInteger} [byteOffset=0] - byte offset\n* @param {NonNegativeInteger} [length] - view length\n* @param {Options} [options] - function options\n* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only vector\n* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed vector dimensions\n* @param {string} [options.order='row-major'] - memory layout (either row-major or column-major)\n* @throws {TypeError} first argument must be either a length, typed array, array-like object, buffer, iterable, or options object\n* @throws {TypeError} must provide valid options\n* @returns {ndarray} one-dimensional ndarray\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector();\n* // returns \n*\n* var len = numel( arr );\n* // returns 0\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector( 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector( [ 1.0, 2.0 ] );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf );\n* // returns \n*\n* var len = numel( arr );\n* // returns 8\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf, 16 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 4\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 64 );\n* var arr = new Float32Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Float32Vector = factory( 'float32' );\n\n\n// EXPORTS //\n\nexport default Float32Vector;\n"],"names":["Float32Vector","factory"],"mappings":";;kGAuGG,IAACA,EAAgBC,EAAS"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 47c8cc7..0000000 --- a/lib/index.js +++ /dev/null @@ -1,100 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 vector (i.e., a one-dimensional ndarray). -* -* @module @stdlib/ndarray-vector-float32 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var v = new Float32Vector(); -* // returns -* -* var len = numel( v ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var v = new Float32Vector( 2 ); -* // returns -* -* var len = numel( v ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var v = new Float32Vector( [ 1.0, 2.0 ] ); -* // returns -* -* var len = numel( v ); -* // returns 2 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var buf = new ArrayBuffer( 32 ); -* var v = new Float32Vector( buf ); -* // returns -* -* var len = numel( v ); -* // returns 8 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var buf = new ArrayBuffer( 32 ); -* var v = new Float32Vector( buf, 16 ); -* // returns -* -* var len = numel( v ); -* // returns 4 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var buf = new ArrayBuffer( 64 ); -* var v = new Float32Vector( buf, 16, 2 ); -* // returns -* -* var len = numel( v ); -* // returns 2 -*/ - -// 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 853738a..0000000 --- a/lib/main.js +++ /dev/null @@ -1,109 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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-vector-ctor' ).factory; - - -// MAIN // - -/** -* Returns a single-precision floating-point vector (i.e., a one-dimensional ndarray). -* -* @name Float32Vector -* @type {Function} -* @param {(NonNegativeInteger|Collection|ArrayBuffer|Iterable)} [arg] - length, typed array, array-like object, buffer, or iterable -* @param {NonNegativeInteger} [byteOffset=0] - byte offset -* @param {NonNegativeInteger} [length] - view length -* @param {Options} [options] - function options -* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only vector -* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed vector dimensions -* @param {string} [options.order='row-major'] - memory layout (either row-major or column-major) -* @throws {TypeError} first argument must be either a length, typed array, array-like object, buffer, iterable, or options object -* @throws {TypeError} must provide valid options -* @returns {ndarray} one-dimensional ndarray -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector(); -* // returns -* -* var len = numel( arr ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector( 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector( [ 1.0, 2.0 ] ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 32 ); -* var arr = new Float32Vector( buf ); -* // returns -* -* var len = numel( arr ); -* // returns 8 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 32 ); -* var arr = new Float32Vector( buf, 16 ); -* // returns -* -* var len = numel( arr ); -* // returns 4 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 64 ); -* var arr = new Float32Vector( buf, 16, 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -*/ -var Float32Vector = factory( 'float32' ); - - -// EXPORTS // - -module.exports = Float32Vector; diff --git a/package.json b/package.json index dba5161..3475c7f 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.0.0", "description": "Create a single-precision floating-point vector (i.e., a one-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,45 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/ndarray-vector-ctor": "github:stdlib-js/ndarray-vector-ctor#main", - "@stdlib/types": "^0.4.3", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-buffer": "^0.2.2", - "@stdlib/array-float32": "^0.2.2", - "@stdlib/array-float64": "^0.2.2", - "@stdlib/assert-is-ndarray-like": "^0.2.2", - "@stdlib/assert-is-ndarray-like-with-data-type": "github:stdlib-js/assert-is-ndarray-like-with-data-type#main", - "@stdlib/assert-is-same-float32array": "^0.2.2", - "@stdlib/blas-ext-sum": "github:stdlib-js/blas-ext-sum#main", - "@stdlib/buffer-from-array": "^0.2.2", - "@stdlib/math-base-special-pow": "^0.3.0", - "@stdlib/ndarray-base-assert-is-read-only": "^0.2.2", - "@stdlib/ndarray-data-buffer": "^0.2.2", - "@stdlib/ndarray-map": "github:stdlib-js/ndarray-map#main", - "@stdlib/random-array-discrete-uniform": "^0.2.1", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", @@ -92,4 +30,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..7618c39 --- /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 fff6e0e..0000000 --- a/test/test.js +++ /dev/null @@ -1,1022 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 Float64Array = require( '@stdlib/array-float64' ); -var Float32Array = require( '@stdlib/array-float32' ); -var getData = require( '@stdlib/ndarray-data-buffer' ); -var array2buffer = require( '@stdlib/buffer-from-array' ); -var Float32Vector = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof Float32Vector, '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, - function noop() {} - ]; - for ( i = 0; i < 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 Float32Vector( 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, - function noop() {} - ]; - for ( i = 0; i < 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 Float32Vector( value, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (byteoffset)', 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 Float32Vector( value, 0 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (byteoffset, 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 Float32Vector( value, 0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (byteoffset, length)', 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 Float32Vector( value, 0, 1 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (byteoffset, length, 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 Float32Vector( value, 0, 1, {} ); - }; - } -}); - -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 Float32Vector( 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 Float32Vector( new ArrayBuffer( 8 ), value, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid byte offset argument (length)', 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 Float32Vector( new ArrayBuffer( 8 ), value, 1 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid byte offset argument (length, 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 Float32Vector( new ArrayBuffer( 8 ), value, 1, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid length 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 Float32Vector( new ArrayBuffer( 8 ), 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid length 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 Float32Vector( new ArrayBuffer( 8 ), 0, value, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (length)', 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 Float32Vector( 10, 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 Float32Vector( [], 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 Float32Vector( 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 Float32Vector( new ArrayBuffer( 8 ), 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (arraybuffer, byteoffset, length)', 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 Float32Vector( new ArrayBuffer( 8 ), 0, 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 Float32Vector({ - '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 Float32Vector({ - 'mode': 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 Float32Vector({ - 'readonly': value - }); - }; - } -}); - -tape( 'the function returns a one-dimensional ndarray', function test( t ) { - var arr; - - arr = new Float32Vector(); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - - arr = new Float32Vector( {} ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (length)', function test( t ) { - var arr; - - arr = new Float32Vector( 10 ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, 'returns expected value' ); - - arr = new Float32Vector( 10, {} ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (array)', function test( t ) { - var arr; - var out; - - arr = [ 1.0, 2.0, 3.0, 4.0 ]; - - out = new Float32Vector( arr ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - out = new Float32Vector( arr, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (typed array)', function test( t ) { - var arr; - var out; - - arr = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - out = new Float32Vector( arr ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - out = new Float32Vector( arr, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (buffer)', function test( t ) { - var arr; - var out; - var buf; - - arr = [ 1, 2, 3, 4 ]; - buf = array2buffer( arr ); - - out = new Float32Vector( buf ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - out = new Float32Vector( buf, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (arraybuffer)', function test( t ) { - var buf; - var out; - - buf = new ArrayBuffer( 8 ); - - out = new Float32Vector( buf ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 2, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf ) ), true, 'returns expected value' ); - - out = new Float32Vector( buf, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 2, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (arraybuffer, byteoffset)', function test( t ) { - var buf; - var out; - - buf = new ArrayBuffer( 32 ); - - out = new Float32Vector( buf, 8 ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 6, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf, 8 ) ), true, 'returns expected value' ); - - out = new Float32Vector( buf, 8, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 6, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf, 8 ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (arraybuffer, byteoffset, length)', function test( t ) { - var buf; - var out; - - buf = new ArrayBuffer( 32 ); - - out = new Float32Vector( buf, 8, 2 ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 2, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf, 8, 2 ) ), true, 'returns expected value' ); - - out = new Float32Vector( buf, 8, 2, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 2, '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 Float32Vector({ - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Float32Vector({ - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - t.strictEqual( arr.order, 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (length)', function test( t ) { - var arr; - - arr = new Float32Vector( 10, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Float32Vector( 10, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, 'returns expected value' ); - t.strictEqual( arr.order, 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (array)', function test( t ) { - var arr; - - arr = new Float32Vector( [ 1.0, 2.0, 3.0, 4.0 ], { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 4, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Float32Vector( [ 1.0, 2.0, 3.0, 4.0 ], { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 4, 'returns expected value' ); - t.strictEqual( arr.order, 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (arraybuffer)', function test( t ) { - var arr; - - arr = new Float32Vector( new ArrayBuffer( 32 ), { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 8, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Float32Vector( new ArrayBuffer( 32 ), { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 8, 'returns expected value' ); - t.strictEqual( arr.order, 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (arraybuffer, byteoffset)', function test( t ) { - var arr; - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 6, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 6, 'returns expected value' ); - t.strictEqual( arr.order, 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (arraybuffer, byteoffset, length)', function test( t ) { - var arr; - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, 2, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 2, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, 2, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 2, 'returns expected value' ); - t.strictEqual( arr.order, 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning read-only ndarrays', function test( t ) { - var arr; - - arr = new Float32Vector({ - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning read-only ndarrays (length)', function test( t ) { - var arr; - - arr = new Float32Vector( 10, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, '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 Float32Vector( [ 1.0, 2.0, 3.0, 4.0 ], { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 4, '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 Float32Vector( new ArrayBuffer( 32 ), { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 8, '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 Float32Vector( new ArrayBuffer( 32 ), 8, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 6, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning read-only ndarrays (arraybuffer, byteoffset, length)', function test( t ) { - var arr; - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, 2, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 2, '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 Float32Vector({ - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning writable ndarrays (length)', function test( t ) { - var arr; - - arr = new Float32Vector( 10, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, '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 Float32Vector( [ 1.0, 2.0, 3.0, 4.0 ], { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 4, '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 Float32Vector( new ArrayBuffer( 32 ), { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 8, '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 Float32Vector( new ArrayBuffer( 32 ), 8, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 6, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning writable ndarrays (arraybuffer, byteoffset, length)', function test( t ) { - var arr; - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, 2, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 2, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); From a85bb2944b65b1a3935cf9fe18237b76b21bc8fd Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 17 May 2025 09:05:53 +0000 Subject: [PATCH 03/42] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 2bc68eb..dba5161 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/ndarray-vector-ctor": "github:stdlib-js/ndarray-vector-ctor#main", - "@stdlib/types": "^0.4.3" + "@stdlib/types": "^0.4.3", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2" }, "devDependencies": { "@stdlib/array-buffer": "^0.2.2", @@ -91,4 +92,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 4f8bbbe8fed67c516f00cc597d3ee5202ea137d4 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 17 May 2025 09:06:12 +0000 Subject: [PATCH 04/42] Remove files --- index.d.ts | 377 ---- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5224 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 bb39900..0000000 --- a/index.d.ts +++ /dev/null @@ -1,377 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 } from '@stdlib/types/ndarray'; -import { Collection, AccessorArrayLike } 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; - - /** - * Boolean indicating whether an array should be read-only (default: false). - */ - readonly?: boolean; -} - -/** -* Interface defining a typed vector constructor which is both "newable" and "callable". -*/ -interface Float32Vector { - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector(); - * // returns - * - * var len = numel( arr ); - * // returns 0 - */ - new ( options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param length - vector length - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector( 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( length: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param obj - array-like object or iterable from which to generate a vector - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector( [ 1.0, 2.0 ] ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( obj: Collection | AccessorArrayLike | Iterable, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Vector( buf ); - * // returns - * - * var len = numel( arr ); - * // returns 8 - */ - new ( buffer: ArrayBuffer, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param byteOffset - integer byte offset specifying the location of the first vector element - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32, 8 ); - * var arr = new Float32Vector( buf ); - * // returns - * - * var len = numel( arr ); - * // returns 6 - */ - new ( buffer: ArrayBuffer, byteOffset: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param byteOffset - integer byte offset specifying the location of the first vector element - * @param length - view length; if not provided, the view spans from the byteOffset to the end of the underlying ArrayBuffer - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32, 8, 2 ); - * var arr = new Float32Vector( buf ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( buffer: ArrayBuffer, byteOffset: number, length: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector(); - * // returns - * - * var len = numel( arr ); - * // returns 0 - */ - ( options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param length - vector length - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector( 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( length: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param obj - array-like object or iterable from which to generate a vector - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector( [ 1.0, 2.0 ] ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( obj: Collection | AccessorArrayLike | Iterable, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Vector( buf ); - * // returns - * - * var len = numel( arr ); - * // returns 8 - */ - ( buffer: ArrayBuffer, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param byteOffset - integer byte offset specifying the location of the first vector element - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32, 8 ); - * var arr = new Float32Vector( buf ); - * // returns - * - * var len = numel( arr ); - * // returns 6 - */ - ( buffer: ArrayBuffer, byteOffset: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param byteOffset - integer byte offset specifying the location of the first vector element - * @param length - view length; if not provided, the view spans from the byteOffset to the end of the underlying ArrayBuffer - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32, 8, 2 ); - * var arr = new Float32Vector( buf ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( buffer: ArrayBuffer, byteOffset: number, length: number, options?: Options ): float32ndarray; -} - -/** -* Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). -* -* @param arg - length, typed array, array-like object, buffer, or iterable -* @param byteOffset - integer byte offset specifying the location of the first vector element (default: 0) -* @param length - view length; if not provided, the view spans from the byteOffset to the end of the underlying ArrayBuffer -* @param options - function options -* @param options.readonly - boolean indicating whether to return a read-only vector -* @param options.mode - specifies how to handle indices which exceed vector dimensions -* @param options.order - memory layout (either row-major or column-major) -* @returns one-dimensional ndarray -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector(); -* // returns -* -* var len = numel( arr ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector( 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector( [ 1.0, 2.0 ] ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 32 ); -* var arr = new Float32Vector( buf, 8, 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -*/ -declare var ctor: Float32Vector; - - -// EXPORTS // - -export = ctor; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 1ff30e9..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2025 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import{factory as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-vector-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 9e33e21..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) 2025 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* 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-vector-ctor';\n\n\n// MAIN //\n\n/**\n* Returns a single-precision floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Float32Vector\n* @type {Function}\n* @param {(NonNegativeInteger|Collection|ArrayBuffer|Iterable)} [arg] - length, typed array, array-like object, buffer, or iterable\n* @param {NonNegativeInteger} [byteOffset=0] - byte offset\n* @param {NonNegativeInteger} [length] - view length\n* @param {Options} [options] - function options\n* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only vector\n* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed vector dimensions\n* @param {string} [options.order='row-major'] - memory layout (either row-major or column-major)\n* @throws {TypeError} first argument must be either a length, typed array, array-like object, buffer, iterable, or options object\n* @throws {TypeError} must provide valid options\n* @returns {ndarray} one-dimensional ndarray\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector();\n* // returns \n*\n* var len = numel( arr );\n* // returns 0\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector( 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector( [ 1.0, 2.0 ] );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf );\n* // returns \n*\n* var len = numel( arr );\n* // returns 8\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf, 16 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 4\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 64 );\n* var arr = new Float32Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Float32Vector = factory( 'float32' );\n\n\n// EXPORTS //\n\nexport default Float32Vector;\n"],"names":["Float32Vector","factory"],"mappings":";;kGAuGG,IAACA,EAAgBC,EAAS"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 7618c39..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From f40e976a0b21d0c88b6bb7ba29087a3bd570b9e3 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 17 May 2025 09:06:58 +0000 Subject: [PATCH 05/42] Auto-generated commit --- .editorconfig | 180 - .eslintrc.js | 1 - .gitattributes | 66 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 794 --- .github/workflows/publish.yml | 252 - .github/workflows/test.yml | 99 - .github/workflows/test_bundles.yml | 186 - .github/workflows/test_coverage.yml | 133 - .github/workflows/test_install.yml | 85 - .github/workflows/test_published_package.yml | 105 - .gitignore | 194 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 49 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 55 +- SECURITY.md | 5 - benchmark/benchmark.js | 47 - benchmark/benchmark.size.js | 93 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 175 - docs/types/test.ts | 86 - examples/index.js | 43 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 100 - lib/main.js | 109 - package.json | 68 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 1022 ---- 44 files changed, 4874 insertions(+), 5214 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 dab5d2a..0000000 --- a/.editorconfig +++ /dev/null @@ -1,180 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim. - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 1c88e69..0000000 --- a/.gitattributes +++ /dev/null @@ -1,66 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index a8a68fb..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/vector/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 f21cc2e..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/vector/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 d88538c..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: '0 0 * * 3' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index f4575e9..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,794 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA - uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 - with: - status: ${{ job.status }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -225,7 +216,7 @@ console.log( v.get() ); ## 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]. @@ -288,9 +279,9 @@ Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-vector-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 7418c03..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,47 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* 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 Float32Vector = require( './../lib' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var arr; - var i; - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr = new Float32Vector( 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 46056e3..0000000 --- a/benchmark/benchmark.size.js +++ /dev/null @@ -1,93 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* 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 isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var pkg = require( './../package.json' ).name; -var Float32Vector = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var arr; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr = new Float32Vector( len ); - if ( arr.length !== len ) { - b.fail( 'unexpected length' ); - } - } - 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 len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':size='+len, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 6d01049..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/vector/float32" -%% click B href "https://github.com/stdlib-js/ndarray-vector-float32/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-vector-float32/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-vector-float32/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-vector-float32/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-vector-float32/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/vector/float32 -[production-url]: https://github.com/stdlib-js/ndarray-vector-float32/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-vector-float32/tree/deno -[deno-readme]: https://github.com/stdlib-js/ndarray-vector-float32/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/ndarray-vector-float32/tree/umd -[umd-readme]: https://github.com/stdlib-js/ndarray-vector-float32/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/ndarray-vector-float32/tree/esm -[esm-readme]: https://github.com/stdlib-js/ndarray-vector-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 7c5ecb1..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var o=function(a,r){return function(){return r||a((r={exports:{}}).exports,r),r.exports}};var e=o(function(f,t){ -var s=require('@stdlib/ndarray-vector-ctor/dist').factory,c=s("float32");t.exports=c -});var i=e();module.exports=i; -/** @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 a14f526..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) 2025 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* 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-vector-ctor' ).factory;\n\n\n// MAIN //\n\n/**\n* Returns a single-precision floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Float32Vector\n* @type {Function}\n* @param {(NonNegativeInteger|Collection|ArrayBuffer|Iterable)} [arg] - length, typed array, array-like object, buffer, or iterable\n* @param {NonNegativeInteger} [byteOffset=0] - byte offset\n* @param {NonNegativeInteger} [length] - view length\n* @param {Options} [options] - function options\n* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only vector\n* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed vector dimensions\n* @param {string} [options.order='row-major'] - memory layout (either row-major or column-major)\n* @throws {TypeError} first argument must be either a length, typed array, array-like object, buffer, iterable, or options object\n* @throws {TypeError} must provide valid options\n* @returns {ndarray} one-dimensional ndarray\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n*\n* var arr = new Float32Vector();\n* // returns \n*\n* var len = numel( arr );\n* // returns 0\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n*\n* var arr = new Float32Vector( 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n*\n* var arr = new Float32Vector( [ 1.0, 2.0 ] );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf );\n* // returns \n*\n* var len = numel( arr );\n* // returns 8\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf, 16 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 4\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n*\n* var buf = new ArrayBuffer( 64 );\n* var arr = new Float32Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Float32Vector = factory( 'float32' );\n\n\n// EXPORTS //\n\nmodule.exports = Float32Vector;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 vector (i.e., a one-dimensional ndarray).\n*\n* @module @stdlib/ndarray-vector-float32\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var v = new Float32Vector();\n* // returns \n*\n* var len = numel( v );\n* // returns 0\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var v = new Float32Vector( 2 );\n* // returns \n*\n* var len = numel( v );\n* // returns 2\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var v = new Float32Vector( [ 1.0, 2.0 ] );\n* // returns \n*\n* var len = numel( v );\n* // returns 2\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var buf = new ArrayBuffer( 32 );\n* var v = new Float32Vector( buf );\n* // returns \n*\n* var len = numel( v );\n* // returns 8\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var buf = new ArrayBuffer( 32 );\n* var v = new Float32Vector( buf, 16 );\n* // returns \n*\n* var len = numel( v );\n* // returns 4\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var buf = new ArrayBuffer( 64 );\n* var v = new Float32Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( v );\n* // returns 2\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,QAAS,6BAA8B,EAAE,QAiFnDC,EAAgBD,EAAS,SAAU,EAKvCD,EAAO,QAAUE,ICdjB,IAAIC,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "factory", "Float32Vector", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index d6ef21a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,175 +0,0 @@ - -{{alias}}( [options] ) - Returns a one-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.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A one-dimensional ndarray. - - Examples - -------- - > var arr = {{alias}}() - - - -{{alias}}( length[, options] ) - Returns a one-dimensional single-precision floating-point ndarray having a - specified length. - - Parameters - ---------- - length: integer - 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.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A one-dimensional ndarray. - - Examples - -------- - > var arr = {{alias}}( 5 ) - - > var len = {{alias:@stdlib/ndarray/numel}}( arr ) - 5 - - -{{alias}}( obj[, options] ) - Creates a one-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. - - 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.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A one-dimensional ndarray. - - Examples - -------- - > var v = [ 1.0, 2.0, 3.0 ]; - > var arr = {{alias}}( v ) - - > var len = {{alias:@stdlib/ndarray/numel}}( arr ) - 3 - - -{{alias}}( buffer[, byteOffset[, length]][, options] ) - Returns a one-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. - - length: integer (optional) - View length. If not provided, the view spans from the byteOffset to - the end of the underlying ArrayBuffer. - - 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.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A one-dimensional ndarray. - - Examples - -------- - > var buf = new {{alias:@stdlib/array/buffer}}( 16 ); - > var arr = {{alias}}( buf, 0, 4 ) - - > var len = {{alias:@stdlib/ndarray/numel}}( arr ) - 4 - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index c222353..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,86 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 Float32Vector = require( './index' ); - - -// TESTS // - -// The function returns an ndarray... -{ - new Float32Vector(); // $ExpectType float32ndarray - new Float32Vector( {} ); // $ExpectType float32ndarray - - new Float32Vector( 10 ); // $ExpectType float32ndarray - new Float32Vector( 10, {} ); // $ExpectType float32ndarray - - new Float32Vector( [ 1, 2, 3 ] ); // $ExpectType float32ndarray - new Float32Vector( [ 1, 2, 3 ], {} ); // $ExpectType float32ndarray - - new Float32Vector( new ArrayBuffer( 10 ) ); // $ExpectType float32ndarray - new Float32Vector( new ArrayBuffer( 10 ), {} ); // $ExpectType float32ndarray - - new Float32Vector( new ArrayBuffer( 10 ), 8 ); // $ExpectType float32ndarray - new Float32Vector( new ArrayBuffer( 10 ), 8, {} ); // $ExpectType float32ndarray - - new Float32Vector( new ArrayBuffer( 10 ), 8, 0 ); // $ExpectType float32ndarray - new Float32Vector( new ArrayBuffer( 10 ), 8, 0, {} ); // $ExpectType float32ndarray - - const vector = Float32Vector; - vector(); // $ExpectType float32ndarray - vector( {} ); // $ExpectType float32ndarray - - vector( 10 ); // $ExpectType float32ndarray - vector( 10, {} ); // $ExpectType float32ndarray - - vector( [ 1, 2, 3 ] ); // $ExpectType float32ndarray - vector( [ 1, 2, 3 ], {} ); // $ExpectType float32ndarray - - vector( new ArrayBuffer( 10 ) ); // $ExpectType float32ndarray - vector( new ArrayBuffer( 10 ), {} ); // $ExpectType float32ndarray - - vector( new ArrayBuffer( 10 ), 8 ); // $ExpectType float32ndarray - vector( new ArrayBuffer( 10 ), 8, {} ); // $ExpectType float32ndarray - - vector( new ArrayBuffer( 10 ), 8, 0 ); // $ExpectType float32ndarray - vector( new ArrayBuffer( 10 ), 8, 0, {} ); // $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 Float32Vector( true ); // $ExpectError - new Float32Vector( false ); // $ExpectError - new Float32Vector( null ); // $ExpectError - new Float32Vector( ( x: number ): number => x ); // $ExpectError - - const vector = Float32Vector; - vector( true ); // $ExpectError - vector( false ); // $ExpectError - vector( null ); // $ExpectError - vector( ( 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 Float32Vector( buf, 8, 2, {}, {} ); // $ExpectError - - const vector = Float32Vector; - vector( buf, 8, 2, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 24af996..0000000 --- a/examples/index.js +++ /dev/null @@ -1,43 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 Float32Vector = require( './../lib' ); - -// Create a vector containing random values: -var x = new Float32Vector( discreteUniform( 10, 0, 100 ) ); - -// Compute the sum: -var v = sum( x ); -console.log( v.get() ); - -// 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: -v = sum( y ); -console.log( v.get() ); 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 0a146a7..bb39900 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 } from '@stdlib/types/ndarray'; import { Collection, AccessorArrayLike } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..1ff30e9 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2025 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import{factory as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-vector-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..9e33e21 --- /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) 2025 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* 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-vector-ctor';\n\n\n// MAIN //\n\n/**\n* Returns a single-precision floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Float32Vector\n* @type {Function}\n* @param {(NonNegativeInteger|Collection|ArrayBuffer|Iterable)} [arg] - length, typed array, array-like object, buffer, or iterable\n* @param {NonNegativeInteger} [byteOffset=0] - byte offset\n* @param {NonNegativeInteger} [length] - view length\n* @param {Options} [options] - function options\n* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only vector\n* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed vector dimensions\n* @param {string} [options.order='row-major'] - memory layout (either row-major or column-major)\n* @throws {TypeError} first argument must be either a length, typed array, array-like object, buffer, iterable, or options object\n* @throws {TypeError} must provide valid options\n* @returns {ndarray} one-dimensional ndarray\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector();\n* // returns \n*\n* var len = numel( arr );\n* // returns 0\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector( 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector( [ 1.0, 2.0 ] );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf );\n* // returns \n*\n* var len = numel( arr );\n* // returns 8\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf, 16 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 4\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 64 );\n* var arr = new Float32Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Float32Vector = factory( 'float32' );\n\n\n// EXPORTS //\n\nexport default Float32Vector;\n"],"names":["Float32Vector","factory"],"mappings":";;kGAuGG,IAACA,EAAgBC,EAAS"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 47c8cc7..0000000 --- a/lib/index.js +++ /dev/null @@ -1,100 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 vector (i.e., a one-dimensional ndarray). -* -* @module @stdlib/ndarray-vector-float32 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var v = new Float32Vector(); -* // returns -* -* var len = numel( v ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var v = new Float32Vector( 2 ); -* // returns -* -* var len = numel( v ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var v = new Float32Vector( [ 1.0, 2.0 ] ); -* // returns -* -* var len = numel( v ); -* // returns 2 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var buf = new ArrayBuffer( 32 ); -* var v = new Float32Vector( buf ); -* // returns -* -* var len = numel( v ); -* // returns 8 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var buf = new ArrayBuffer( 32 ); -* var v = new Float32Vector( buf, 16 ); -* // returns -* -* var len = numel( v ); -* // returns 4 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var buf = new ArrayBuffer( 64 ); -* var v = new Float32Vector( buf, 16, 2 ); -* // returns -* -* var len = numel( v ); -* // returns 2 -*/ - -// 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 853738a..0000000 --- a/lib/main.js +++ /dev/null @@ -1,109 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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-vector-ctor' ).factory; - - -// MAIN // - -/** -* Returns a single-precision floating-point vector (i.e., a one-dimensional ndarray). -* -* @name Float32Vector -* @type {Function} -* @param {(NonNegativeInteger|Collection|ArrayBuffer|Iterable)} [arg] - length, typed array, array-like object, buffer, or iterable -* @param {NonNegativeInteger} [byteOffset=0] - byte offset -* @param {NonNegativeInteger} [length] - view length -* @param {Options} [options] - function options -* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only vector -* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed vector dimensions -* @param {string} [options.order='row-major'] - memory layout (either row-major or column-major) -* @throws {TypeError} first argument must be either a length, typed array, array-like object, buffer, iterable, or options object -* @throws {TypeError} must provide valid options -* @returns {ndarray} one-dimensional ndarray -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector(); -* // returns -* -* var len = numel( arr ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector( 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector( [ 1.0, 2.0 ] ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 32 ); -* var arr = new Float32Vector( buf ); -* // returns -* -* var len = numel( arr ); -* // returns 8 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 32 ); -* var arr = new Float32Vector( buf, 16 ); -* // returns -* -* var len = numel( arr ); -* // returns 4 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 64 ); -* var arr = new Float32Vector( buf, 16, 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -*/ -var Float32Vector = factory( 'float32' ); - - -// EXPORTS // - -module.exports = Float32Vector; diff --git a/package.json b/package.json index dba5161..3475c7f 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.0.0", "description": "Create a single-precision floating-point vector (i.e., a one-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,45 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/ndarray-vector-ctor": "github:stdlib-js/ndarray-vector-ctor#main", - "@stdlib/types": "^0.4.3", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-buffer": "^0.2.2", - "@stdlib/array-float32": "^0.2.2", - "@stdlib/array-float64": "^0.2.2", - "@stdlib/assert-is-ndarray-like": "^0.2.2", - "@stdlib/assert-is-ndarray-like-with-data-type": "github:stdlib-js/assert-is-ndarray-like-with-data-type#main", - "@stdlib/assert-is-same-float32array": "^0.2.2", - "@stdlib/blas-ext-sum": "github:stdlib-js/blas-ext-sum#main", - "@stdlib/buffer-from-array": "^0.2.2", - "@stdlib/math-base-special-pow": "^0.3.0", - "@stdlib/ndarray-base-assert-is-read-only": "^0.2.2", - "@stdlib/ndarray-data-buffer": "^0.2.2", - "@stdlib/ndarray-map": "github:stdlib-js/ndarray-map#main", - "@stdlib/random-array-discrete-uniform": "^0.2.1", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", @@ -92,4 +30,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..7618c39 --- /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 fff6e0e..0000000 --- a/test/test.js +++ /dev/null @@ -1,1022 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 Float64Array = require( '@stdlib/array-float64' ); -var Float32Array = require( '@stdlib/array-float32' ); -var getData = require( '@stdlib/ndarray-data-buffer' ); -var array2buffer = require( '@stdlib/buffer-from-array' ); -var Float32Vector = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof Float32Vector, '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, - function noop() {} - ]; - for ( i = 0; i < 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 Float32Vector( 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, - function noop() {} - ]; - for ( i = 0; i < 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 Float32Vector( value, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (byteoffset)', 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 Float32Vector( value, 0 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (byteoffset, 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 Float32Vector( value, 0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (byteoffset, length)', 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 Float32Vector( value, 0, 1 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (byteoffset, length, 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 Float32Vector( value, 0, 1, {} ); - }; - } -}); - -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 Float32Vector( 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 Float32Vector( new ArrayBuffer( 8 ), value, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid byte offset argument (length)', 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 Float32Vector( new ArrayBuffer( 8 ), value, 1 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid byte offset argument (length, 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 Float32Vector( new ArrayBuffer( 8 ), value, 1, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid length 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 Float32Vector( new ArrayBuffer( 8 ), 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid length 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 Float32Vector( new ArrayBuffer( 8 ), 0, value, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (length)', 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 Float32Vector( 10, 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 Float32Vector( [], 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 Float32Vector( 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 Float32Vector( new ArrayBuffer( 8 ), 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (arraybuffer, byteoffset, length)', 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 Float32Vector( new ArrayBuffer( 8 ), 0, 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 Float32Vector({ - '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 Float32Vector({ - 'mode': 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 Float32Vector({ - 'readonly': value - }); - }; - } -}); - -tape( 'the function returns a one-dimensional ndarray', function test( t ) { - var arr; - - arr = new Float32Vector(); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - - arr = new Float32Vector( {} ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (length)', function test( t ) { - var arr; - - arr = new Float32Vector( 10 ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, 'returns expected value' ); - - arr = new Float32Vector( 10, {} ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (array)', function test( t ) { - var arr; - var out; - - arr = [ 1.0, 2.0, 3.0, 4.0 ]; - - out = new Float32Vector( arr ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - out = new Float32Vector( arr, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (typed array)', function test( t ) { - var arr; - var out; - - arr = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - out = new Float32Vector( arr ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - out = new Float32Vector( arr, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (buffer)', function test( t ) { - var arr; - var out; - var buf; - - arr = [ 1, 2, 3, 4 ]; - buf = array2buffer( arr ); - - out = new Float32Vector( buf ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - out = new Float32Vector( buf, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (arraybuffer)', function test( t ) { - var buf; - var out; - - buf = new ArrayBuffer( 8 ); - - out = new Float32Vector( buf ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 2, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf ) ), true, 'returns expected value' ); - - out = new Float32Vector( buf, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 2, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (arraybuffer, byteoffset)', function test( t ) { - var buf; - var out; - - buf = new ArrayBuffer( 32 ); - - out = new Float32Vector( buf, 8 ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 6, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf, 8 ) ), true, 'returns expected value' ); - - out = new Float32Vector( buf, 8, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 6, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf, 8 ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (arraybuffer, byteoffset, length)', function test( t ) { - var buf; - var out; - - buf = new ArrayBuffer( 32 ); - - out = new Float32Vector( buf, 8, 2 ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 2, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf, 8, 2 ) ), true, 'returns expected value' ); - - out = new Float32Vector( buf, 8, 2, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 2, '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 Float32Vector({ - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Float32Vector({ - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - t.strictEqual( arr.order, 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (length)', function test( t ) { - var arr; - - arr = new Float32Vector( 10, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Float32Vector( 10, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, 'returns expected value' ); - t.strictEqual( arr.order, 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (array)', function test( t ) { - var arr; - - arr = new Float32Vector( [ 1.0, 2.0, 3.0, 4.0 ], { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 4, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Float32Vector( [ 1.0, 2.0, 3.0, 4.0 ], { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 4, 'returns expected value' ); - t.strictEqual( arr.order, 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (arraybuffer)', function test( t ) { - var arr; - - arr = new Float32Vector( new ArrayBuffer( 32 ), { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 8, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Float32Vector( new ArrayBuffer( 32 ), { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 8, 'returns expected value' ); - t.strictEqual( arr.order, 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (arraybuffer, byteoffset)', function test( t ) { - var arr; - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 6, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 6, 'returns expected value' ); - t.strictEqual( arr.order, 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (arraybuffer, byteoffset, length)', function test( t ) { - var arr; - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, 2, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 2, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, 2, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 2, 'returns expected value' ); - t.strictEqual( arr.order, 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning read-only ndarrays', function test( t ) { - var arr; - - arr = new Float32Vector({ - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning read-only ndarrays (length)', function test( t ) { - var arr; - - arr = new Float32Vector( 10, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, '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 Float32Vector( [ 1.0, 2.0, 3.0, 4.0 ], { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 4, '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 Float32Vector( new ArrayBuffer( 32 ), { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 8, '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 Float32Vector( new ArrayBuffer( 32 ), 8, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 6, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning read-only ndarrays (arraybuffer, byteoffset, length)', function test( t ) { - var arr; - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, 2, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 2, '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 Float32Vector({ - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning writable ndarrays (length)', function test( t ) { - var arr; - - arr = new Float32Vector( 10, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, '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 Float32Vector( [ 1.0, 2.0, 3.0, 4.0 ], { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 4, '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 Float32Vector( new ArrayBuffer( 32 ), { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 8, '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 Float32Vector( new ArrayBuffer( 32 ), 8, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 6, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning writable ndarrays (arraybuffer, byteoffset, length)', function test( t ) { - var arr; - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, 2, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 2, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); From 0c03bea88af593fae14c9902c6d7fbcdc9d6b66f Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 17 May 2025 19:08:13 +0000 Subject: [PATCH 06/42] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 2bc68eb..dba5161 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/ndarray-vector-ctor": "github:stdlib-js/ndarray-vector-ctor#main", - "@stdlib/types": "^0.4.3" + "@stdlib/types": "^0.4.3", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2" }, "devDependencies": { "@stdlib/array-buffer": "^0.2.2", @@ -91,4 +92,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From ca0ef02952ce1b1b54116da688cb891e9964c99a Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 17 May 2025 19:08:35 +0000 Subject: [PATCH 07/42] Remove files --- index.d.ts | 377 ---- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5224 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 bb39900..0000000 --- a/index.d.ts +++ /dev/null @@ -1,377 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 } from '@stdlib/types/ndarray'; -import { Collection, AccessorArrayLike } 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; - - /** - * Boolean indicating whether an array should be read-only (default: false). - */ - readonly?: boolean; -} - -/** -* Interface defining a typed vector constructor which is both "newable" and "callable". -*/ -interface Float32Vector { - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector(); - * // returns - * - * var len = numel( arr ); - * // returns 0 - */ - new ( options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param length - vector length - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector( 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( length: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param obj - array-like object or iterable from which to generate a vector - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector( [ 1.0, 2.0 ] ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( obj: Collection | AccessorArrayLike | Iterable, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Vector( buf ); - * // returns - * - * var len = numel( arr ); - * // returns 8 - */ - new ( buffer: ArrayBuffer, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param byteOffset - integer byte offset specifying the location of the first vector element - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32, 8 ); - * var arr = new Float32Vector( buf ); - * // returns - * - * var len = numel( arr ); - * // returns 6 - */ - new ( buffer: ArrayBuffer, byteOffset: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param byteOffset - integer byte offset specifying the location of the first vector element - * @param length - view length; if not provided, the view spans from the byteOffset to the end of the underlying ArrayBuffer - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32, 8, 2 ); - * var arr = new Float32Vector( buf ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( buffer: ArrayBuffer, byteOffset: number, length: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector(); - * // returns - * - * var len = numel( arr ); - * // returns 0 - */ - ( options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param length - vector length - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector( 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( length: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param obj - array-like object or iterable from which to generate a vector - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector( [ 1.0, 2.0 ] ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( obj: Collection | AccessorArrayLike | Iterable, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Vector( buf ); - * // returns - * - * var len = numel( arr ); - * // returns 8 - */ - ( buffer: ArrayBuffer, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param byteOffset - integer byte offset specifying the location of the first vector element - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32, 8 ); - * var arr = new Float32Vector( buf ); - * // returns - * - * var len = numel( arr ); - * // returns 6 - */ - ( buffer: ArrayBuffer, byteOffset: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param byteOffset - integer byte offset specifying the location of the first vector element - * @param length - view length; if not provided, the view spans from the byteOffset to the end of the underlying ArrayBuffer - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32, 8, 2 ); - * var arr = new Float32Vector( buf ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( buffer: ArrayBuffer, byteOffset: number, length: number, options?: Options ): float32ndarray; -} - -/** -* Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). -* -* @param arg - length, typed array, array-like object, buffer, or iterable -* @param byteOffset - integer byte offset specifying the location of the first vector element (default: 0) -* @param length - view length; if not provided, the view spans from the byteOffset to the end of the underlying ArrayBuffer -* @param options - function options -* @param options.readonly - boolean indicating whether to return a read-only vector -* @param options.mode - specifies how to handle indices which exceed vector dimensions -* @param options.order - memory layout (either row-major or column-major) -* @returns one-dimensional ndarray -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector(); -* // returns -* -* var len = numel( arr ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector( 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector( [ 1.0, 2.0 ] ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 32 ); -* var arr = new Float32Vector( buf, 8, 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -*/ -declare var ctor: Float32Vector; - - -// EXPORTS // - -export = ctor; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 1ff30e9..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2025 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import{factory as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-vector-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 9e33e21..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) 2025 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* 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-vector-ctor';\n\n\n// MAIN //\n\n/**\n* Returns a single-precision floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Float32Vector\n* @type {Function}\n* @param {(NonNegativeInteger|Collection|ArrayBuffer|Iterable)} [arg] - length, typed array, array-like object, buffer, or iterable\n* @param {NonNegativeInteger} [byteOffset=0] - byte offset\n* @param {NonNegativeInteger} [length] - view length\n* @param {Options} [options] - function options\n* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only vector\n* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed vector dimensions\n* @param {string} [options.order='row-major'] - memory layout (either row-major or column-major)\n* @throws {TypeError} first argument must be either a length, typed array, array-like object, buffer, iterable, or options object\n* @throws {TypeError} must provide valid options\n* @returns {ndarray} one-dimensional ndarray\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector();\n* // returns \n*\n* var len = numel( arr );\n* // returns 0\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector( 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector( [ 1.0, 2.0 ] );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf );\n* // returns \n*\n* var len = numel( arr );\n* // returns 8\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf, 16 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 4\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 64 );\n* var arr = new Float32Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Float32Vector = factory( 'float32' );\n\n\n// EXPORTS //\n\nexport default Float32Vector;\n"],"names":["Float32Vector","factory"],"mappings":";;kGAuGG,IAACA,EAAgBC,EAAS"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 7618c39..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 8cca8b6bdc0d67bff0e4ec824c305038684ffcf1 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 17 May 2025 19:09:15 +0000 Subject: [PATCH 08/42] Auto-generated commit --- .editorconfig | 180 - .eslintrc.js | 1 - .gitattributes | 66 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 794 --- .github/workflows/publish.yml | 252 - .github/workflows/test.yml | 99 - .github/workflows/test_bundles.yml | 186 - .github/workflows/test_coverage.yml | 133 - .github/workflows/test_install.yml | 85 - .github/workflows/test_published_package.yml | 105 - .gitignore | 194 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 50 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 55 +- SECURITY.md | 5 - benchmark/benchmark.js | 47 - benchmark/benchmark.size.js | 93 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 175 - docs/types/test.ts | 86 - examples/index.js | 43 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 100 - lib/main.js | 109 - package.json | 68 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 1022 ---- 44 files changed, 4874 insertions(+), 5215 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 dab5d2a..0000000 --- a/.editorconfig +++ /dev/null @@ -1,180 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim. - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 1c88e69..0000000 --- a/.gitattributes +++ /dev/null @@ -1,66 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index a8a68fb..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/vector/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 f21cc2e..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/vector/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 d88538c..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: '0 0 * * 3' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index f4575e9..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,794 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA - uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 - with: - status: ${{ job.status }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -225,7 +216,7 @@ console.log( v.get() ); ## 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]. @@ -288,9 +279,9 @@ Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-vector-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 7418c03..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,47 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* 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 Float32Vector = require( './../lib' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var arr; - var i; - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr = new Float32Vector( 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 46056e3..0000000 --- a/benchmark/benchmark.size.js +++ /dev/null @@ -1,93 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* 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 isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var pkg = require( './../package.json' ).name; -var Float32Vector = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var arr; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr = new Float32Vector( len ); - if ( arr.length !== len ) { - b.fail( 'unexpected length' ); - } - } - 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 len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':size='+len, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 6d01049..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/vector/float32" -%% click B href "https://github.com/stdlib-js/ndarray-vector-float32/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-vector-float32/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-vector-float32/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-vector-float32/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-vector-float32/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/vector/float32 -[production-url]: https://github.com/stdlib-js/ndarray-vector-float32/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-vector-float32/tree/deno -[deno-readme]: https://github.com/stdlib-js/ndarray-vector-float32/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/ndarray-vector-float32/tree/umd -[umd-readme]: https://github.com/stdlib-js/ndarray-vector-float32/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/ndarray-vector-float32/tree/esm -[esm-readme]: https://github.com/stdlib-js/ndarray-vector-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 7c5ecb1..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var o=function(a,r){return function(){return r||a((r={exports:{}}).exports,r),r.exports}};var e=o(function(f,t){ -var s=require('@stdlib/ndarray-vector-ctor/dist').factory,c=s("float32");t.exports=c -});var i=e();module.exports=i; -/** @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 a14f526..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) 2025 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* 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-vector-ctor' ).factory;\n\n\n// MAIN //\n\n/**\n* Returns a single-precision floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Float32Vector\n* @type {Function}\n* @param {(NonNegativeInteger|Collection|ArrayBuffer|Iterable)} [arg] - length, typed array, array-like object, buffer, or iterable\n* @param {NonNegativeInteger} [byteOffset=0] - byte offset\n* @param {NonNegativeInteger} [length] - view length\n* @param {Options} [options] - function options\n* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only vector\n* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed vector dimensions\n* @param {string} [options.order='row-major'] - memory layout (either row-major or column-major)\n* @throws {TypeError} first argument must be either a length, typed array, array-like object, buffer, iterable, or options object\n* @throws {TypeError} must provide valid options\n* @returns {ndarray} one-dimensional ndarray\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n*\n* var arr = new Float32Vector();\n* // returns \n*\n* var len = numel( arr );\n* // returns 0\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n*\n* var arr = new Float32Vector( 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n*\n* var arr = new Float32Vector( [ 1.0, 2.0 ] );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf );\n* // returns \n*\n* var len = numel( arr );\n* // returns 8\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf, 16 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 4\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n*\n* var buf = new ArrayBuffer( 64 );\n* var arr = new Float32Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Float32Vector = factory( 'float32' );\n\n\n// EXPORTS //\n\nmodule.exports = Float32Vector;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 vector (i.e., a one-dimensional ndarray).\n*\n* @module @stdlib/ndarray-vector-float32\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var v = new Float32Vector();\n* // returns \n*\n* var len = numel( v );\n* // returns 0\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var v = new Float32Vector( 2 );\n* // returns \n*\n* var len = numel( v );\n* // returns 2\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var v = new Float32Vector( [ 1.0, 2.0 ] );\n* // returns \n*\n* var len = numel( v );\n* // returns 2\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var buf = new ArrayBuffer( 32 );\n* var v = new Float32Vector( buf );\n* // returns \n*\n* var len = numel( v );\n* // returns 8\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var buf = new ArrayBuffer( 32 );\n* var v = new Float32Vector( buf, 16 );\n* // returns \n*\n* var len = numel( v );\n* // returns 4\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var buf = new ArrayBuffer( 64 );\n* var v = new Float32Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( v );\n* // returns 2\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,QAAS,6BAA8B,EAAE,QAiFnDC,EAAgBD,EAAS,SAAU,EAKvCD,EAAO,QAAUE,ICdjB,IAAIC,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "factory", "Float32Vector", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index a92bbdd..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,175 +0,0 @@ - -{{alias}}( [options] ) - Returns a one-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.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A one-dimensional ndarray. - - Examples - -------- - > var arr = {{alias}}() - - - -{{alias}}( length[, options] ) - Returns a one-dimensional single-precision floating-point ndarray having a - specified length. - - Parameters - ---------- - length: integer - 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.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A one-dimensional ndarray. - - Examples - -------- - > var arr = {{alias}}( 5 ) - - > var len = {{alias:@stdlib/ndarray/numel}}( arr ) - 5 - - -{{alias}}( obj[, options] ) - Creates a one-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. - - 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.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A one-dimensional ndarray. - - Examples - -------- - > var v = [ 1.0, 2.0, 3.0 ]; - > var arr = {{alias}}( v ) - - > var len = {{alias:@stdlib/ndarray/numel}}( arr ) - 3 - - -{{alias}}( buffer[, byteOffset[, length]][, options] ) - Returns a one-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. - - length: integer (optional) - View length. If not provided, the view spans from the byteOffset to - the end of the underlying ArrayBuffer. - - 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.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A one-dimensional ndarray. - - Examples - -------- - > var buf = new {{alias:@stdlib/array/buffer}}( 32 ); - > var arr = {{alias}}( buf, 0, 4 ) - - > var len = {{alias:@stdlib/ndarray/numel}}( arr ) - 4 - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index c222353..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,86 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 Float32Vector = require( './index' ); - - -// TESTS // - -// The function returns an ndarray... -{ - new Float32Vector(); // $ExpectType float32ndarray - new Float32Vector( {} ); // $ExpectType float32ndarray - - new Float32Vector( 10 ); // $ExpectType float32ndarray - new Float32Vector( 10, {} ); // $ExpectType float32ndarray - - new Float32Vector( [ 1, 2, 3 ] ); // $ExpectType float32ndarray - new Float32Vector( [ 1, 2, 3 ], {} ); // $ExpectType float32ndarray - - new Float32Vector( new ArrayBuffer( 10 ) ); // $ExpectType float32ndarray - new Float32Vector( new ArrayBuffer( 10 ), {} ); // $ExpectType float32ndarray - - new Float32Vector( new ArrayBuffer( 10 ), 8 ); // $ExpectType float32ndarray - new Float32Vector( new ArrayBuffer( 10 ), 8, {} ); // $ExpectType float32ndarray - - new Float32Vector( new ArrayBuffer( 10 ), 8, 0 ); // $ExpectType float32ndarray - new Float32Vector( new ArrayBuffer( 10 ), 8, 0, {} ); // $ExpectType float32ndarray - - const vector = Float32Vector; - vector(); // $ExpectType float32ndarray - vector( {} ); // $ExpectType float32ndarray - - vector( 10 ); // $ExpectType float32ndarray - vector( 10, {} ); // $ExpectType float32ndarray - - vector( [ 1, 2, 3 ] ); // $ExpectType float32ndarray - vector( [ 1, 2, 3 ], {} ); // $ExpectType float32ndarray - - vector( new ArrayBuffer( 10 ) ); // $ExpectType float32ndarray - vector( new ArrayBuffer( 10 ), {} ); // $ExpectType float32ndarray - - vector( new ArrayBuffer( 10 ), 8 ); // $ExpectType float32ndarray - vector( new ArrayBuffer( 10 ), 8, {} ); // $ExpectType float32ndarray - - vector( new ArrayBuffer( 10 ), 8, 0 ); // $ExpectType float32ndarray - vector( new ArrayBuffer( 10 ), 8, 0, {} ); // $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 Float32Vector( true ); // $ExpectError - new Float32Vector( false ); // $ExpectError - new Float32Vector( null ); // $ExpectError - new Float32Vector( ( x: number ): number => x ); // $ExpectError - - const vector = Float32Vector; - vector( true ); // $ExpectError - vector( false ); // $ExpectError - vector( null ); // $ExpectError - vector( ( 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 Float32Vector( buf, 8, 2, {}, {} ); // $ExpectError - - const vector = Float32Vector; - vector( buf, 8, 2, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 24af996..0000000 --- a/examples/index.js +++ /dev/null @@ -1,43 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 Float32Vector = require( './../lib' ); - -// Create a vector containing random values: -var x = new Float32Vector( discreteUniform( 10, 0, 100 ) ); - -// Compute the sum: -var v = sum( x ); -console.log( v.get() ); - -// 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: -v = sum( y ); -console.log( v.get() ); 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 0a146a7..bb39900 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 } from '@stdlib/types/ndarray'; import { Collection, AccessorArrayLike } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..1ff30e9 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2025 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import{factory as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-vector-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..9e33e21 --- /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) 2025 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* 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-vector-ctor';\n\n\n// MAIN //\n\n/**\n* Returns a single-precision floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Float32Vector\n* @type {Function}\n* @param {(NonNegativeInteger|Collection|ArrayBuffer|Iterable)} [arg] - length, typed array, array-like object, buffer, or iterable\n* @param {NonNegativeInteger} [byteOffset=0] - byte offset\n* @param {NonNegativeInteger} [length] - view length\n* @param {Options} [options] - function options\n* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only vector\n* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed vector dimensions\n* @param {string} [options.order='row-major'] - memory layout (either row-major or column-major)\n* @throws {TypeError} first argument must be either a length, typed array, array-like object, buffer, iterable, or options object\n* @throws {TypeError} must provide valid options\n* @returns {ndarray} one-dimensional ndarray\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector();\n* // returns \n*\n* var len = numel( arr );\n* // returns 0\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector( 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector( [ 1.0, 2.0 ] );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf );\n* // returns \n*\n* var len = numel( arr );\n* // returns 8\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf, 16 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 4\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 64 );\n* var arr = new Float32Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Float32Vector = factory( 'float32' );\n\n\n// EXPORTS //\n\nexport default Float32Vector;\n"],"names":["Float32Vector","factory"],"mappings":";;kGAuGG,IAACA,EAAgBC,EAAS"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 47c8cc7..0000000 --- a/lib/index.js +++ /dev/null @@ -1,100 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 vector (i.e., a one-dimensional ndarray). -* -* @module @stdlib/ndarray-vector-float32 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var v = new Float32Vector(); -* // returns -* -* var len = numel( v ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var v = new Float32Vector( 2 ); -* // returns -* -* var len = numel( v ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var v = new Float32Vector( [ 1.0, 2.0 ] ); -* // returns -* -* var len = numel( v ); -* // returns 2 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var buf = new ArrayBuffer( 32 ); -* var v = new Float32Vector( buf ); -* // returns -* -* var len = numel( v ); -* // returns 8 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var buf = new ArrayBuffer( 32 ); -* var v = new Float32Vector( buf, 16 ); -* // returns -* -* var len = numel( v ); -* // returns 4 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var buf = new ArrayBuffer( 64 ); -* var v = new Float32Vector( buf, 16, 2 ); -* // returns -* -* var len = numel( v ); -* // returns 2 -*/ - -// 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 853738a..0000000 --- a/lib/main.js +++ /dev/null @@ -1,109 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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-vector-ctor' ).factory; - - -// MAIN // - -/** -* Returns a single-precision floating-point vector (i.e., a one-dimensional ndarray). -* -* @name Float32Vector -* @type {Function} -* @param {(NonNegativeInteger|Collection|ArrayBuffer|Iterable)} [arg] - length, typed array, array-like object, buffer, or iterable -* @param {NonNegativeInteger} [byteOffset=0] - byte offset -* @param {NonNegativeInteger} [length] - view length -* @param {Options} [options] - function options -* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only vector -* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed vector dimensions -* @param {string} [options.order='row-major'] - memory layout (either row-major or column-major) -* @throws {TypeError} first argument must be either a length, typed array, array-like object, buffer, iterable, or options object -* @throws {TypeError} must provide valid options -* @returns {ndarray} one-dimensional ndarray -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector(); -* // returns -* -* var len = numel( arr ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector( 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector( [ 1.0, 2.0 ] ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 32 ); -* var arr = new Float32Vector( buf ); -* // returns -* -* var len = numel( arr ); -* // returns 8 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 32 ); -* var arr = new Float32Vector( buf, 16 ); -* // returns -* -* var len = numel( arr ); -* // returns 4 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 64 ); -* var arr = new Float32Vector( buf, 16, 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -*/ -var Float32Vector = factory( 'float32' ); - - -// EXPORTS // - -module.exports = Float32Vector; diff --git a/package.json b/package.json index dba5161..3475c7f 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.0.0", "description": "Create a single-precision floating-point vector (i.e., a one-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,45 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/ndarray-vector-ctor": "github:stdlib-js/ndarray-vector-ctor#main", - "@stdlib/types": "^0.4.3", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-buffer": "^0.2.2", - "@stdlib/array-float32": "^0.2.2", - "@stdlib/array-float64": "^0.2.2", - "@stdlib/assert-is-ndarray-like": "^0.2.2", - "@stdlib/assert-is-ndarray-like-with-data-type": "github:stdlib-js/assert-is-ndarray-like-with-data-type#main", - "@stdlib/assert-is-same-float32array": "^0.2.2", - "@stdlib/blas-ext-sum": "github:stdlib-js/blas-ext-sum#main", - "@stdlib/buffer-from-array": "^0.2.2", - "@stdlib/math-base-special-pow": "^0.3.0", - "@stdlib/ndarray-base-assert-is-read-only": "^0.2.2", - "@stdlib/ndarray-data-buffer": "^0.2.2", - "@stdlib/ndarray-map": "github:stdlib-js/ndarray-map#main", - "@stdlib/random-array-discrete-uniform": "^0.2.1", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", @@ -92,4 +30,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..7618c39 --- /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 fff6e0e..0000000 --- a/test/test.js +++ /dev/null @@ -1,1022 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 Float64Array = require( '@stdlib/array-float64' ); -var Float32Array = require( '@stdlib/array-float32' ); -var getData = require( '@stdlib/ndarray-data-buffer' ); -var array2buffer = require( '@stdlib/buffer-from-array' ); -var Float32Vector = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof Float32Vector, '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, - function noop() {} - ]; - for ( i = 0; i < 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 Float32Vector( 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, - function noop() {} - ]; - for ( i = 0; i < 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 Float32Vector( value, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (byteoffset)', 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 Float32Vector( value, 0 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (byteoffset, 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 Float32Vector( value, 0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (byteoffset, length)', 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 Float32Vector( value, 0, 1 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (byteoffset, length, 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 Float32Vector( value, 0, 1, {} ); - }; - } -}); - -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 Float32Vector( 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 Float32Vector( new ArrayBuffer( 8 ), value, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid byte offset argument (length)', 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 Float32Vector( new ArrayBuffer( 8 ), value, 1 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid byte offset argument (length, 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 Float32Vector( new ArrayBuffer( 8 ), value, 1, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid length 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 Float32Vector( new ArrayBuffer( 8 ), 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid length 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 Float32Vector( new ArrayBuffer( 8 ), 0, value, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (length)', 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 Float32Vector( 10, 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 Float32Vector( [], 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 Float32Vector( 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 Float32Vector( new ArrayBuffer( 8 ), 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (arraybuffer, byteoffset, length)', 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 Float32Vector( new ArrayBuffer( 8 ), 0, 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 Float32Vector({ - '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 Float32Vector({ - 'mode': 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 Float32Vector({ - 'readonly': value - }); - }; - } -}); - -tape( 'the function returns a one-dimensional ndarray', function test( t ) { - var arr; - - arr = new Float32Vector(); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - - arr = new Float32Vector( {} ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (length)', function test( t ) { - var arr; - - arr = new Float32Vector( 10 ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, 'returns expected value' ); - - arr = new Float32Vector( 10, {} ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (array)', function test( t ) { - var arr; - var out; - - arr = [ 1.0, 2.0, 3.0, 4.0 ]; - - out = new Float32Vector( arr ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - out = new Float32Vector( arr, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (typed array)', function test( t ) { - var arr; - var out; - - arr = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - out = new Float32Vector( arr ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - out = new Float32Vector( arr, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (buffer)', function test( t ) { - var arr; - var out; - var buf; - - arr = [ 1, 2, 3, 4 ]; - buf = array2buffer( arr ); - - out = new Float32Vector( buf ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - out = new Float32Vector( buf, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (arraybuffer)', function test( t ) { - var buf; - var out; - - buf = new ArrayBuffer( 8 ); - - out = new Float32Vector( buf ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 2, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf ) ), true, 'returns expected value' ); - - out = new Float32Vector( buf, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 2, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (arraybuffer, byteoffset)', function test( t ) { - var buf; - var out; - - buf = new ArrayBuffer( 32 ); - - out = new Float32Vector( buf, 8 ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 6, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf, 8 ) ), true, 'returns expected value' ); - - out = new Float32Vector( buf, 8, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 6, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf, 8 ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (arraybuffer, byteoffset, length)', function test( t ) { - var buf; - var out; - - buf = new ArrayBuffer( 32 ); - - out = new Float32Vector( buf, 8, 2 ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 2, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf, 8, 2 ) ), true, 'returns expected value' ); - - out = new Float32Vector( buf, 8, 2, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 2, '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 Float32Vector({ - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Float32Vector({ - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - t.strictEqual( arr.order, 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (length)', function test( t ) { - var arr; - - arr = new Float32Vector( 10, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Float32Vector( 10, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, 'returns expected value' ); - t.strictEqual( arr.order, 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (array)', function test( t ) { - var arr; - - arr = new Float32Vector( [ 1.0, 2.0, 3.0, 4.0 ], { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 4, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Float32Vector( [ 1.0, 2.0, 3.0, 4.0 ], { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 4, 'returns expected value' ); - t.strictEqual( arr.order, 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (arraybuffer)', function test( t ) { - var arr; - - arr = new Float32Vector( new ArrayBuffer( 32 ), { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 8, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Float32Vector( new ArrayBuffer( 32 ), { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 8, 'returns expected value' ); - t.strictEqual( arr.order, 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (arraybuffer, byteoffset)', function test( t ) { - var arr; - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 6, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 6, 'returns expected value' ); - t.strictEqual( arr.order, 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (arraybuffer, byteoffset, length)', function test( t ) { - var arr; - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, 2, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 2, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, 2, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 2, 'returns expected value' ); - t.strictEqual( arr.order, 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning read-only ndarrays', function test( t ) { - var arr; - - arr = new Float32Vector({ - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning read-only ndarrays (length)', function test( t ) { - var arr; - - arr = new Float32Vector( 10, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, '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 Float32Vector( [ 1.0, 2.0, 3.0, 4.0 ], { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 4, '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 Float32Vector( new ArrayBuffer( 32 ), { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 8, '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 Float32Vector( new ArrayBuffer( 32 ), 8, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 6, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning read-only ndarrays (arraybuffer, byteoffset, length)', function test( t ) { - var arr; - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, 2, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 2, '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 Float32Vector({ - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning writable ndarrays (length)', function test( t ) { - var arr; - - arr = new Float32Vector( 10, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, '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 Float32Vector( [ 1.0, 2.0, 3.0, 4.0 ], { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 4, '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 Float32Vector( new ArrayBuffer( 32 ), { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 8, '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 Float32Vector( new ArrayBuffer( 32 ), 8, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 6, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning writable ndarrays (arraybuffer, byteoffset, length)', function test( t ) { - var arr; - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, 2, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 2, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); From ff6c8d6a15227cb754a0908450082fe95ddac799 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 31 Jan 2026 06:47:42 +0000 Subject: [PATCH 09/42] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 24fb07b..b3c20d3 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/ndarray-vector-ctor": "github:stdlib-js/ndarray-vector-ctor#main", - "@stdlib/types": "^0.4.3" + "@stdlib/types": "^0.4.3", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2" }, "devDependencies": { "@stdlib/array-buffer": "^0.2.2", @@ -91,4 +92,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 0ade3e1bf54bf7d05b0a37338b91443a7bf6929c Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 31 Jan 2026 07:50:32 +0000 Subject: [PATCH 10/42] Remove files --- index.d.ts | 377 ---- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5224 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 bb39900..0000000 --- a/index.d.ts +++ /dev/null @@ -1,377 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 } from '@stdlib/types/ndarray'; -import { Collection, AccessorArrayLike } 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; - - /** - * Boolean indicating whether an array should be read-only (default: false). - */ - readonly?: boolean; -} - -/** -* Interface defining a typed vector constructor which is both "newable" and "callable". -*/ -interface Float32Vector { - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector(); - * // returns - * - * var len = numel( arr ); - * // returns 0 - */ - new ( options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param length - vector length - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector( 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( length: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param obj - array-like object or iterable from which to generate a vector - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector( [ 1.0, 2.0 ] ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( obj: Collection | AccessorArrayLike | Iterable, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Vector( buf ); - * // returns - * - * var len = numel( arr ); - * // returns 8 - */ - new ( buffer: ArrayBuffer, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param byteOffset - integer byte offset specifying the location of the first vector element - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32, 8 ); - * var arr = new Float32Vector( buf ); - * // returns - * - * var len = numel( arr ); - * // returns 6 - */ - new ( buffer: ArrayBuffer, byteOffset: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param byteOffset - integer byte offset specifying the location of the first vector element - * @param length - view length; if not provided, the view spans from the byteOffset to the end of the underlying ArrayBuffer - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32, 8, 2 ); - * var arr = new Float32Vector( buf ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( buffer: ArrayBuffer, byteOffset: number, length: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector(); - * // returns - * - * var len = numel( arr ); - * // returns 0 - */ - ( options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param length - vector length - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector( 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( length: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param obj - array-like object or iterable from which to generate a vector - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector( [ 1.0, 2.0 ] ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( obj: Collection | AccessorArrayLike | Iterable, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Vector( buf ); - * // returns - * - * var len = numel( arr ); - * // returns 8 - */ - ( buffer: ArrayBuffer, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param byteOffset - integer byte offset specifying the location of the first vector element - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32, 8 ); - * var arr = new Float32Vector( buf ); - * // returns - * - * var len = numel( arr ); - * // returns 6 - */ - ( buffer: ArrayBuffer, byteOffset: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param byteOffset - integer byte offset specifying the location of the first vector element - * @param length - view length; if not provided, the view spans from the byteOffset to the end of the underlying ArrayBuffer - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32, 8, 2 ); - * var arr = new Float32Vector( buf ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( buffer: ArrayBuffer, byteOffset: number, length: number, options?: Options ): float32ndarray; -} - -/** -* Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). -* -* @param arg - length, typed array, array-like object, buffer, or iterable -* @param byteOffset - integer byte offset specifying the location of the first vector element (default: 0) -* @param length - view length; if not provided, the view spans from the byteOffset to the end of the underlying ArrayBuffer -* @param options - function options -* @param options.readonly - boolean indicating whether to return a read-only vector -* @param options.mode - specifies how to handle indices which exceed vector dimensions -* @param options.order - memory layout (either row-major or column-major) -* @returns one-dimensional ndarray -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector(); -* // returns -* -* var len = numel( arr ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector( 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector( [ 1.0, 2.0 ] ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 32 ); -* var arr = new Float32Vector( buf, 8, 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -*/ -declare var ctor: Float32Vector; - - -// EXPORTS // - -export = ctor; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 1ff30e9..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2025 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import{factory as t}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-vector-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 9e33e21..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) 2025 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* 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-vector-ctor';\n\n\n// MAIN //\n\n/**\n* Returns a single-precision floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Float32Vector\n* @type {Function}\n* @param {(NonNegativeInteger|Collection|ArrayBuffer|Iterable)} [arg] - length, typed array, array-like object, buffer, or iterable\n* @param {NonNegativeInteger} [byteOffset=0] - byte offset\n* @param {NonNegativeInteger} [length] - view length\n* @param {Options} [options] - function options\n* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only vector\n* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed vector dimensions\n* @param {string} [options.order='row-major'] - memory layout (either row-major or column-major)\n* @throws {TypeError} first argument must be either a length, typed array, array-like object, buffer, iterable, or options object\n* @throws {TypeError} must provide valid options\n* @returns {ndarray} one-dimensional ndarray\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector();\n* // returns \n*\n* var len = numel( arr );\n* // returns 0\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector( 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector( [ 1.0, 2.0 ] );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf );\n* // returns \n*\n* var len = numel( arr );\n* // returns 8\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf, 16 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 4\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 64 );\n* var arr = new Float32Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Float32Vector = factory( 'float32' );\n\n\n// EXPORTS //\n\nexport default Float32Vector;\n"],"names":["Float32Vector","factory"],"mappings":";;kGAuGG,IAACA,EAAgBC,EAAS"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 7618c39..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From f49b6e33645e1406cbc832342831eaff577c9744 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 31 Jan 2026 07:51:06 +0000 Subject: [PATCH 11/42] Auto-generated commit --- .editorconfig | 180 - .eslintrc.js | 1 - .gitattributes | 66 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 821 --- .github/workflows/publish.yml | 261 - .github/workflows/test.yml | 108 - .github/workflows/test_bundles.yml | 213 - .github/workflows/test_coverage.yml | 142 - .github/workflows/test_install.yml | 94 - .github/workflows/test_published_package.yml | 115 - .gitignore | 199 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 52 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 55 +- SECURITY.md | 5 - benchmark/benchmark.js | 47 - benchmark/benchmark.size.js | 93 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 175 - docs/types/test.ts | 86 - examples/index.js | 43 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 100 - lib/main.js | 109 - package.json | 68 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 1022 ---- 44 files changed, 4874 insertions(+), 5322 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 dab5d2a..0000000 --- a/.editorconfig +++ /dev/null @@ -1,180 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim. - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 1c88e69..0000000 --- a/.gitattributes +++ /dev/null @@ -1,66 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index a8a68fb..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/vector/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 f21cc2e..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/vector/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 d88538c..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: '0 0 * * 3' - - # 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 + + ```
@@ -225,7 +216,7 @@ console.log( v.get() ); ## 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]. @@ -288,9 +279,9 @@ Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-vector-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 7418c03..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,47 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* 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 Float32Vector = require( './../lib' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var arr; - var i; - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr = new Float32Vector( 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 46056e3..0000000 --- a/benchmark/benchmark.size.js +++ /dev/null @@ -1,93 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* 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 isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var pkg = require( './../package.json' ).name; -var Float32Vector = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var arr; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr = new Float32Vector( len ); - if ( arr.length !== len ) { - b.fail( 'unexpected length' ); - } - } - 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 len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':size='+len, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 6d01049..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/vector/float32" -%% click B href "https://github.com/stdlib-js/ndarray-vector-float32/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-vector-float32/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-vector-float32/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-vector-float32/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-vector-float32/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/vector/float32 -[production-url]: https://github.com/stdlib-js/ndarray-vector-float32/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-vector-float32/tree/deno -[deno-readme]: https://github.com/stdlib-js/ndarray-vector-float32/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/ndarray-vector-float32/tree/umd -[umd-readme]: https://github.com/stdlib-js/ndarray-vector-float32/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/ndarray-vector-float32/tree/esm -[esm-readme]: https://github.com/stdlib-js/ndarray-vector-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 7c5ecb1..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var o=function(a,r){return function(){return r||a((r={exports:{}}).exports,r),r.exports}};var e=o(function(f,t){ -var s=require('@stdlib/ndarray-vector-ctor/dist').factory,c=s("float32");t.exports=c -});var i=e();module.exports=i; -/** @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 a14f526..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) 2025 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* 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-vector-ctor' ).factory;\n\n\n// MAIN //\n\n/**\n* Returns a single-precision floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Float32Vector\n* @type {Function}\n* @param {(NonNegativeInteger|Collection|ArrayBuffer|Iterable)} [arg] - length, typed array, array-like object, buffer, or iterable\n* @param {NonNegativeInteger} [byteOffset=0] - byte offset\n* @param {NonNegativeInteger} [length] - view length\n* @param {Options} [options] - function options\n* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only vector\n* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed vector dimensions\n* @param {string} [options.order='row-major'] - memory layout (either row-major or column-major)\n* @throws {TypeError} first argument must be either a length, typed array, array-like object, buffer, iterable, or options object\n* @throws {TypeError} must provide valid options\n* @returns {ndarray} one-dimensional ndarray\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n*\n* var arr = new Float32Vector();\n* // returns \n*\n* var len = numel( arr );\n* // returns 0\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n*\n* var arr = new Float32Vector( 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n*\n* var arr = new Float32Vector( [ 1.0, 2.0 ] );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf );\n* // returns \n*\n* var len = numel( arr );\n* // returns 8\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf, 16 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 4\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n*\n* var buf = new ArrayBuffer( 64 );\n* var arr = new Float32Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Float32Vector = factory( 'float32' );\n\n\n// EXPORTS //\n\nmodule.exports = Float32Vector;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 vector (i.e., a one-dimensional ndarray).\n*\n* @module @stdlib/ndarray-vector-float32\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var v = new Float32Vector();\n* // returns \n*\n* var len = numel( v );\n* // returns 0\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var v = new Float32Vector( 2 );\n* // returns \n*\n* var len = numel( v );\n* // returns 2\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var v = new Float32Vector( [ 1.0, 2.0 ] );\n* // returns \n*\n* var len = numel( v );\n* // returns 2\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var buf = new ArrayBuffer( 32 );\n* var v = new Float32Vector( buf );\n* // returns \n*\n* var len = numel( v );\n* // returns 8\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var buf = new ArrayBuffer( 32 );\n* var v = new Float32Vector( buf, 16 );\n* // returns \n*\n* var len = numel( v );\n* // returns 4\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var buf = new ArrayBuffer( 64 );\n* var v = new Float32Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( v );\n* // returns 2\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,QAAS,6BAA8B,EAAE,QAiFnDC,EAAgBD,EAAS,SAAU,EAKvCD,EAAO,QAAUE,ICdjB,IAAIC,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "factory", "Float32Vector", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index a92bbdd..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,175 +0,0 @@ - -{{alias}}( [options] ) - Returns a one-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.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A one-dimensional ndarray. - - Examples - -------- - > var arr = {{alias}}() - - - -{{alias}}( length[, options] ) - Returns a one-dimensional single-precision floating-point ndarray having a - specified length. - - Parameters - ---------- - length: integer - 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.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A one-dimensional ndarray. - - Examples - -------- - > var arr = {{alias}}( 5 ) - - > var len = {{alias:@stdlib/ndarray/numel}}( arr ) - 5 - - -{{alias}}( obj[, options] ) - Creates a one-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. - - 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.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A one-dimensional ndarray. - - Examples - -------- - > var v = [ 1.0, 2.0, 3.0 ]; - > var arr = {{alias}}( v ) - - > var len = {{alias:@stdlib/ndarray/numel}}( arr ) - 3 - - -{{alias}}( buffer[, byteOffset[, length]][, options] ) - Returns a one-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. - - length: integer (optional) - View length. If not provided, the view spans from the byteOffset to - the end of the underlying ArrayBuffer. - - 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.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A one-dimensional ndarray. - - Examples - -------- - > var buf = new {{alias:@stdlib/array/buffer}}( 32 ); - > var arr = {{alias}}( buf, 0, 4 ) - - > var len = {{alias:@stdlib/ndarray/numel}}( arr ) - 4 - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index c222353..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,86 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 Float32Vector = require( './index' ); - - -// TESTS // - -// The function returns an ndarray... -{ - new Float32Vector(); // $ExpectType float32ndarray - new Float32Vector( {} ); // $ExpectType float32ndarray - - new Float32Vector( 10 ); // $ExpectType float32ndarray - new Float32Vector( 10, {} ); // $ExpectType float32ndarray - - new Float32Vector( [ 1, 2, 3 ] ); // $ExpectType float32ndarray - new Float32Vector( [ 1, 2, 3 ], {} ); // $ExpectType float32ndarray - - new Float32Vector( new ArrayBuffer( 10 ) ); // $ExpectType float32ndarray - new Float32Vector( new ArrayBuffer( 10 ), {} ); // $ExpectType float32ndarray - - new Float32Vector( new ArrayBuffer( 10 ), 8 ); // $ExpectType float32ndarray - new Float32Vector( new ArrayBuffer( 10 ), 8, {} ); // $ExpectType float32ndarray - - new Float32Vector( new ArrayBuffer( 10 ), 8, 0 ); // $ExpectType float32ndarray - new Float32Vector( new ArrayBuffer( 10 ), 8, 0, {} ); // $ExpectType float32ndarray - - const vector = Float32Vector; - vector(); // $ExpectType float32ndarray - vector( {} ); // $ExpectType float32ndarray - - vector( 10 ); // $ExpectType float32ndarray - vector( 10, {} ); // $ExpectType float32ndarray - - vector( [ 1, 2, 3 ] ); // $ExpectType float32ndarray - vector( [ 1, 2, 3 ], {} ); // $ExpectType float32ndarray - - vector( new ArrayBuffer( 10 ) ); // $ExpectType float32ndarray - vector( new ArrayBuffer( 10 ), {} ); // $ExpectType float32ndarray - - vector( new ArrayBuffer( 10 ), 8 ); // $ExpectType float32ndarray - vector( new ArrayBuffer( 10 ), 8, {} ); // $ExpectType float32ndarray - - vector( new ArrayBuffer( 10 ), 8, 0 ); // $ExpectType float32ndarray - vector( new ArrayBuffer( 10 ), 8, 0, {} ); // $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 Float32Vector( true ); // $ExpectError - new Float32Vector( false ); // $ExpectError - new Float32Vector( null ); // $ExpectError - new Float32Vector( ( x: number ): number => x ); // $ExpectError - - const vector = Float32Vector; - vector( true ); // $ExpectError - vector( false ); // $ExpectError - vector( null ); // $ExpectError - vector( ( 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 Float32Vector( buf, 8, 2, {}, {} ); // $ExpectError - - const vector = Float32Vector; - vector( buf, 8, 2, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 24af996..0000000 --- a/examples/index.js +++ /dev/null @@ -1,43 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 Float32Vector = require( './../lib' ); - -// Create a vector containing random values: -var x = new Float32Vector( discreteUniform( 10, 0, 100 ) ); - -// Compute the sum: -var v = sum( x ); -console.log( v.get() ); - -// 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: -v = sum( y ); -console.log( v.get() ); 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 346c235..fe7ae4c 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 } from '@stdlib/types/ndarray'; import { Collection, AccessorArrayLike } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..e9a3d6a --- /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-vector-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..9e33e21 --- /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) 2025 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* 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-vector-ctor';\n\n\n// MAIN //\n\n/**\n* Returns a single-precision floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Float32Vector\n* @type {Function}\n* @param {(NonNegativeInteger|Collection|ArrayBuffer|Iterable)} [arg] - length, typed array, array-like object, buffer, or iterable\n* @param {NonNegativeInteger} [byteOffset=0] - byte offset\n* @param {NonNegativeInteger} [length] - view length\n* @param {Options} [options] - function options\n* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only vector\n* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed vector dimensions\n* @param {string} [options.order='row-major'] - memory layout (either row-major or column-major)\n* @throws {TypeError} first argument must be either a length, typed array, array-like object, buffer, iterable, or options object\n* @throws {TypeError} must provide valid options\n* @returns {ndarray} one-dimensional ndarray\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector();\n* // returns \n*\n* var len = numel( arr );\n* // returns 0\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector( 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector( [ 1.0, 2.0 ] );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf );\n* // returns \n*\n* var len = numel( arr );\n* // returns 8\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf, 16 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 4\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 64 );\n* var arr = new Float32Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Float32Vector = factory( 'float32' );\n\n\n// EXPORTS //\n\nexport default Float32Vector;\n"],"names":["Float32Vector","factory"],"mappings":";;kGAuGG,IAACA,EAAgBC,EAAS"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 47c8cc7..0000000 --- a/lib/index.js +++ /dev/null @@ -1,100 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 vector (i.e., a one-dimensional ndarray). -* -* @module @stdlib/ndarray-vector-float32 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var v = new Float32Vector(); -* // returns -* -* var len = numel( v ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var v = new Float32Vector( 2 ); -* // returns -* -* var len = numel( v ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var v = new Float32Vector( [ 1.0, 2.0 ] ); -* // returns -* -* var len = numel( v ); -* // returns 2 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var buf = new ArrayBuffer( 32 ); -* var v = new Float32Vector( buf ); -* // returns -* -* var len = numel( v ); -* // returns 8 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var buf = new ArrayBuffer( 32 ); -* var v = new Float32Vector( buf, 16 ); -* // returns -* -* var len = numel( v ); -* // returns 4 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var buf = new ArrayBuffer( 64 ); -* var v = new Float32Vector( buf, 16, 2 ); -* // returns -* -* var len = numel( v ); -* // returns 2 -*/ - -// 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 853738a..0000000 --- a/lib/main.js +++ /dev/null @@ -1,109 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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-vector-ctor' ).factory; - - -// MAIN // - -/** -* Returns a single-precision floating-point vector (i.e., a one-dimensional ndarray). -* -* @name Float32Vector -* @type {Function} -* @param {(NonNegativeInteger|Collection|ArrayBuffer|Iterable)} [arg] - length, typed array, array-like object, buffer, or iterable -* @param {NonNegativeInteger} [byteOffset=0] - byte offset -* @param {NonNegativeInteger} [length] - view length -* @param {Options} [options] - function options -* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only vector -* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed vector dimensions -* @param {string} [options.order='row-major'] - memory layout (either row-major or column-major) -* @throws {TypeError} first argument must be either a length, typed array, array-like object, buffer, iterable, or options object -* @throws {TypeError} must provide valid options -* @returns {ndarray} one-dimensional ndarray -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector(); -* // returns -* -* var len = numel( arr ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector( 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector( [ 1.0, 2.0 ] ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 32 ); -* var arr = new Float32Vector( buf ); -* // returns -* -* var len = numel( arr ); -* // returns 8 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 32 ); -* var arr = new Float32Vector( buf, 16 ); -* // returns -* -* var len = numel( arr ); -* // returns 4 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 64 ); -* var arr = new Float32Vector( buf, 16, 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -*/ -var Float32Vector = factory( 'float32' ); - - -// EXPORTS // - -module.exports = Float32Vector; diff --git a/package.json b/package.json index b3c20d3..cdc033a 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.0", "description": "Create a single-precision floating-point vector (i.e., a one-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,45 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/ndarray-vector-ctor": "github:stdlib-js/ndarray-vector-ctor#main", - "@stdlib/types": "^0.4.3", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-buffer": "^0.2.2", - "@stdlib/array-float32": "^0.2.2", - "@stdlib/array-float64": "^0.2.2", - "@stdlib/assert-is-ndarray-like": "^0.2.2", - "@stdlib/assert-is-ndarray-like-with-data-type": "^0.1.0", - "@stdlib/assert-is-same-float32array": "^0.2.2", - "@stdlib/blas-ext-sum": "github:stdlib-js/blas-ext-sum#main", - "@stdlib/buffer-from-array": "^0.2.2", - "@stdlib/math-base-special-pow": "^0.3.0", - "@stdlib/ndarray-base-assert-is-read-only": "^0.2.2", - "@stdlib/ndarray-data-buffer": "^0.2.2", - "@stdlib/ndarray-map": "^0.1.0", - "@stdlib/random-array-discrete-uniform": "^0.2.1", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", @@ -92,4 +30,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..7618c39 --- /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 fff6e0e..0000000 --- a/test/test.js +++ /dev/null @@ -1,1022 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 Float64Array = require( '@stdlib/array-float64' ); -var Float32Array = require( '@stdlib/array-float32' ); -var getData = require( '@stdlib/ndarray-data-buffer' ); -var array2buffer = require( '@stdlib/buffer-from-array' ); -var Float32Vector = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof Float32Vector, '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, - function noop() {} - ]; - for ( i = 0; i < 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 Float32Vector( 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, - function noop() {} - ]; - for ( i = 0; i < 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 Float32Vector( value, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (byteoffset)', 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 Float32Vector( value, 0 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (byteoffset, 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 Float32Vector( value, 0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (byteoffset, length)', 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 Float32Vector( value, 0, 1 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (byteoffset, length, 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 Float32Vector( value, 0, 1, {} ); - }; - } -}); - -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 Float32Vector( 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 Float32Vector( new ArrayBuffer( 8 ), value, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid byte offset argument (length)', 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 Float32Vector( new ArrayBuffer( 8 ), value, 1 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid byte offset argument (length, 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 Float32Vector( new ArrayBuffer( 8 ), value, 1, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid length 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 Float32Vector( new ArrayBuffer( 8 ), 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid length 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 Float32Vector( new ArrayBuffer( 8 ), 0, value, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (length)', 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 Float32Vector( 10, 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 Float32Vector( [], 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 Float32Vector( 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 Float32Vector( new ArrayBuffer( 8 ), 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (arraybuffer, byteoffset, length)', 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 Float32Vector( new ArrayBuffer( 8 ), 0, 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 Float32Vector({ - '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 Float32Vector({ - 'mode': 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 Float32Vector({ - 'readonly': value - }); - }; - } -}); - -tape( 'the function returns a one-dimensional ndarray', function test( t ) { - var arr; - - arr = new Float32Vector(); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - - arr = new Float32Vector( {} ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (length)', function test( t ) { - var arr; - - arr = new Float32Vector( 10 ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, 'returns expected value' ); - - arr = new Float32Vector( 10, {} ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (array)', function test( t ) { - var arr; - var out; - - arr = [ 1.0, 2.0, 3.0, 4.0 ]; - - out = new Float32Vector( arr ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - out = new Float32Vector( arr, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (typed array)', function test( t ) { - var arr; - var out; - - arr = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - out = new Float32Vector( arr ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - out = new Float32Vector( arr, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (buffer)', function test( t ) { - var arr; - var out; - var buf; - - arr = [ 1, 2, 3, 4 ]; - buf = array2buffer( arr ); - - out = new Float32Vector( buf ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - out = new Float32Vector( buf, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (arraybuffer)', function test( t ) { - var buf; - var out; - - buf = new ArrayBuffer( 8 ); - - out = new Float32Vector( buf ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 2, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf ) ), true, 'returns expected value' ); - - out = new Float32Vector( buf, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 2, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (arraybuffer, byteoffset)', function test( t ) { - var buf; - var out; - - buf = new ArrayBuffer( 32 ); - - out = new Float32Vector( buf, 8 ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 6, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf, 8 ) ), true, 'returns expected value' ); - - out = new Float32Vector( buf, 8, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 6, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf, 8 ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (arraybuffer, byteoffset, length)', function test( t ) { - var buf; - var out; - - buf = new ArrayBuffer( 32 ); - - out = new Float32Vector( buf, 8, 2 ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 2, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf, 8, 2 ) ), true, 'returns expected value' ); - - out = new Float32Vector( buf, 8, 2, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 2, '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 Float32Vector({ - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Float32Vector({ - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - t.strictEqual( arr.order, 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (length)', function test( t ) { - var arr; - - arr = new Float32Vector( 10, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Float32Vector( 10, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, 'returns expected value' ); - t.strictEqual( arr.order, 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (array)', function test( t ) { - var arr; - - arr = new Float32Vector( [ 1.0, 2.0, 3.0, 4.0 ], { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 4, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Float32Vector( [ 1.0, 2.0, 3.0, 4.0 ], { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 4, 'returns expected value' ); - t.strictEqual( arr.order, 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (arraybuffer)', function test( t ) { - var arr; - - arr = new Float32Vector( new ArrayBuffer( 32 ), { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 8, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Float32Vector( new ArrayBuffer( 32 ), { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 8, 'returns expected value' ); - t.strictEqual( arr.order, 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (arraybuffer, byteoffset)', function test( t ) { - var arr; - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 6, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 6, 'returns expected value' ); - t.strictEqual( arr.order, 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (arraybuffer, byteoffset, length)', function test( t ) { - var arr; - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, 2, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 2, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, 2, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 2, 'returns expected value' ); - t.strictEqual( arr.order, 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning read-only ndarrays', function test( t ) { - var arr; - - arr = new Float32Vector({ - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning read-only ndarrays (length)', function test( t ) { - var arr; - - arr = new Float32Vector( 10, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, '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 Float32Vector( [ 1.0, 2.0, 3.0, 4.0 ], { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 4, '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 Float32Vector( new ArrayBuffer( 32 ), { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 8, '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 Float32Vector( new ArrayBuffer( 32 ), 8, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 6, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning read-only ndarrays (arraybuffer, byteoffset, length)', function test( t ) { - var arr; - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, 2, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 2, '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 Float32Vector({ - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning writable ndarrays (length)', function test( t ) { - var arr; - - arr = new Float32Vector( 10, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, '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 Float32Vector( [ 1.0, 2.0, 3.0, 4.0 ], { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 4, '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 Float32Vector( new ArrayBuffer( 32 ), { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 8, '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 Float32Vector( new ArrayBuffer( 32 ), 8, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 6, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning writable ndarrays (arraybuffer, byteoffset, length)', function test( t ) { - var arr; - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, 2, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 2, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); From e229073575a93a853da869aff4a2d9b563266e4f Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 31 Jan 2026 08:21:15 +0000 Subject: [PATCH 12/42] Update README.md for ESM bundle v0.1.0 --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index af7044f..e9f8d8c 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,7 @@ limitations under the License. ## Usage ```javascript -import Float32Vector from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-vector-float32@esm/index.mjs'; +import Float32Vector from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-vector-float32@v0.1.0-esm/index.mjs'; ``` #### Float32Vector( \[options] ) @@ -161,7 +161,7 @@ var len3 = numel( arr3 ); import discreteUniform from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-discrete-uniform@esm/index.mjs'; import sum from 'https://cdn.jsdelivr.net/gh/stdlib-js/blas-ext-sum@esm/index.mjs'; import map from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-map@esm/index.mjs'; -import Float32Vector from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-vector-float32@esm/index.mjs'; +import Float32Vector from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-vector-float32@v0.1.0-esm/index.mjs'; // Create a vector containing random values: var x = new Float32Vector( discreteUniform( 10, 0, 100 ) ); From fe4e4641e17a214f47fda97a222c3b5175eb30a7 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 31 Jan 2026 08:21:16 +0000 Subject: [PATCH 13/42] Auto-generated commit --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e9f8d8c..7d99663 100644 --- a/README.md +++ b/README.md @@ -51,6 +51,11 @@ limitations under the License. ## Usage +```javascript +import Float32Vector from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-vector-float32@esm/index.mjs'; +``` +The previous example will load the latest bundled code from the esm branch. Alternatively, you may load a specific version by loading the file from one of the [tagged bundles](https://github.com/stdlib-js/ndarray-vector-float32/tags). For example, + ```javascript import Float32Vector from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-vector-float32@v0.1.0-esm/index.mjs'; ``` @@ -161,7 +166,7 @@ var len3 = numel( arr3 ); import discreteUniform from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-discrete-uniform@esm/index.mjs'; import sum from 'https://cdn.jsdelivr.net/gh/stdlib-js/blas-ext-sum@esm/index.mjs'; import map from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-map@esm/index.mjs'; -import Float32Vector from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-vector-float32@v0.1.0-esm/index.mjs'; +import Float32Vector from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-vector-float32@esm/index.mjs'; // Create a vector containing random values: var x = new Float32Vector( discreteUniform( 10, 0, 100 ) ); From e051a103c373b6541be7c6da81c3707a4c74797a Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 8 Feb 2026 23:14:44 +0000 Subject: [PATCH 14/42] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 30fbb93..7bd48c3 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/ndarray-vector-ctor": "^0.1.0", - "@stdlib/types": "^0.4.3" + "@stdlib/types": "^0.4.3", + "@stdlib/error-tools-fmtprodmsg": "^0.2.3" }, "devDependencies": { "@stdlib/array-buffer": "^0.2.3", @@ -91,4 +92,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 08954977dfc2590ba74074876adce1c759bdef1f Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 9 Feb 2026 00:05:25 +0000 Subject: [PATCH 15/42] Remove files --- index.d.ts | 377 ---- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5224 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 fe7ae4c..0000000 --- a/index.d.ts +++ /dev/null @@ -1,377 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 } from '@stdlib/types/ndarray'; -import { Collection, AccessorArrayLike } 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; - - /** - * Boolean indicating whether an array should be read-only (default: false). - */ - readonly?: boolean; -} - -/** -* Interface defining a typed vector constructor which is both "newable" and "callable". -*/ -interface Float32Vector { - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector(); - * // returns - * - * var len = numel( arr ); - * // returns 0 - */ - new ( options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param length - vector length - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector( 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( length: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param obj - array-like object or iterable from which to generate a vector - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector( [ 1.0, 2.0 ] ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( obj: Collection | AccessorArrayLike | Iterable, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Vector( buf ); - * // returns - * - * var len = numel( arr ); - * // returns 8 - */ - new ( buffer: ArrayBuffer, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param byteOffset - integer byte offset specifying the location of the first vector element - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Vector( buf, 8 ); - * // returns - * - * var len = numel( arr ); - * // returns 6 - */ - new ( buffer: ArrayBuffer, byteOffset: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param byteOffset - integer byte offset specifying the location of the first vector element - * @param length - view length; if not provided, the view spans from the byteOffset to the end of the underlying ArrayBuffer - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Vector( buf, 8, 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( buffer: ArrayBuffer, byteOffset: number, length: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector(); - * // returns - * - * var len = numel( arr ); - * // returns 0 - */ - ( options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param length - vector length - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector( 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( length: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param obj - array-like object or iterable from which to generate a vector - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector( [ 1.0, 2.0 ] ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( obj: Collection | AccessorArrayLike | Iterable, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Vector( buf ); - * // returns - * - * var len = numel( arr ); - * // returns 8 - */ - ( buffer: ArrayBuffer, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param byteOffset - integer byte offset specifying the location of the first vector element - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Vector( buf, 8 ); - * // returns - * - * var len = numel( arr ); - * // returns 6 - */ - ( buffer: ArrayBuffer, byteOffset: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param byteOffset - integer byte offset specifying the location of the first vector element - * @param length - view length; if not provided, the view spans from the byteOffset to the end of the underlying ArrayBuffer - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Vector( buf, 8, 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( buffer: ArrayBuffer, byteOffset: number, length: number, options?: Options ): float32ndarray; -} - -/** -* Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). -* -* @param arg - length, typed array, array-like object, buffer, or iterable -* @param byteOffset - integer byte offset specifying the location of the first vector element (default: 0) -* @param length - view length; if not provided, the view spans from the byteOffset to the end of the underlying ArrayBuffer -* @param options - function options -* @param options.readonly - boolean indicating whether to return a read-only vector -* @param options.mode - specifies how to handle indices which exceed vector dimensions -* @param options.order - memory layout (either row-major or column-major) -* @returns one-dimensional ndarray -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector(); -* // returns -* -* var len = numel( arr ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector( 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector( [ 1.0, 2.0 ] ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 32 ); -* var arr = new Float32Vector( buf, 8, 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -*/ -declare var ctor: Float32Vector; - - -// EXPORTS // - -export = ctor; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index e9a3d6a..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-vector-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 9e33e21..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) 2025 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* 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-vector-ctor';\n\n\n// MAIN //\n\n/**\n* Returns a single-precision floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Float32Vector\n* @type {Function}\n* @param {(NonNegativeInteger|Collection|ArrayBuffer|Iterable)} [arg] - length, typed array, array-like object, buffer, or iterable\n* @param {NonNegativeInteger} [byteOffset=0] - byte offset\n* @param {NonNegativeInteger} [length] - view length\n* @param {Options} [options] - function options\n* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only vector\n* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed vector dimensions\n* @param {string} [options.order='row-major'] - memory layout (either row-major or column-major)\n* @throws {TypeError} first argument must be either a length, typed array, array-like object, buffer, iterable, or options object\n* @throws {TypeError} must provide valid options\n* @returns {ndarray} one-dimensional ndarray\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector();\n* // returns \n*\n* var len = numel( arr );\n* // returns 0\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector( 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector( [ 1.0, 2.0 ] );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf );\n* // returns \n*\n* var len = numel( arr );\n* // returns 8\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf, 16 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 4\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 64 );\n* var arr = new Float32Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Float32Vector = factory( 'float32' );\n\n\n// EXPORTS //\n\nexport default Float32Vector;\n"],"names":["Float32Vector","factory"],"mappings":";;kGAuGG,IAACA,EAAgBC,EAAS"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 7618c39..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 07328526209cba6ce7137081c3ba06a6f27574ed Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 9 Feb 2026 00:05:55 +0000 Subject: [PATCH 16/42] Auto-generated commit --- .editorconfig | 180 - .eslintrc.js | 1 - .gitattributes | 66 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 821 --- .github/workflows/publish.yml | 261 - .github/workflows/test.yml | 101 - .github/workflows/test_bundles.yml | 213 - .github/workflows/test_coverage.yml | 142 - .github/workflows/test_install.yml | 94 - .github/workflows/test_published_package.yml | 115 - .gitignore | 199 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 62 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 55 +- SECURITY.md | 5 - benchmark/benchmark.js | 47 - benchmark/benchmark.size.js | 93 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 175 - docs/types/test.ts | 86 - examples/index.js | 43 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 100 - lib/main.js | 109 - package.json | 68 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 1022 ---- 44 files changed, 4874 insertions(+), 5325 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 dab5d2a..0000000 --- a/.editorconfig +++ /dev/null @@ -1,180 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim. - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 1c88e69..0000000 --- a/.gitattributes +++ /dev/null @@ -1,66 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index a8a68fb..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/vector/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 f21cc2e..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/vector/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 d88538c..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: '0 0 * * 3' - - # 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 + + ```
@@ -225,7 +216,7 @@ console.log( v.get() ); ## 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]. @@ -288,9 +279,9 @@ Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-vector-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 7418c03..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,47 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* 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 Float32Vector = require( './../lib' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var arr; - var i; - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr = new Float32Vector( 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 46056e3..0000000 --- a/benchmark/benchmark.size.js +++ /dev/null @@ -1,93 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* 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 isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var pkg = require( './../package.json' ).name; -var Float32Vector = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var arr; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr = new Float32Vector( len ); - if ( arr.length !== len ) { - b.fail( 'unexpected length' ); - } - } - 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 len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':size='+len, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 6d01049..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/vector/float32" -%% click B href "https://github.com/stdlib-js/ndarray-vector-float32/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-vector-float32/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-vector-float32/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-vector-float32/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-vector-float32/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/vector/float32 -[production-url]: https://github.com/stdlib-js/ndarray-vector-float32/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-vector-float32/tree/deno -[deno-readme]: https://github.com/stdlib-js/ndarray-vector-float32/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/ndarray-vector-float32/tree/umd -[umd-readme]: https://github.com/stdlib-js/ndarray-vector-float32/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/ndarray-vector-float32/tree/esm -[esm-readme]: https://github.com/stdlib-js/ndarray-vector-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 7c5ecb1..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var o=function(a,r){return function(){return r||a((r={exports:{}}).exports,r),r.exports}};var e=o(function(f,t){ -var s=require('@stdlib/ndarray-vector-ctor/dist').factory,c=s("float32");t.exports=c -});var i=e();module.exports=i; -/** @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 a14f526..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) 2025 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* 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-vector-ctor' ).factory;\n\n\n// MAIN //\n\n/**\n* Returns a single-precision floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Float32Vector\n* @type {Function}\n* @param {(NonNegativeInteger|Collection|ArrayBuffer|Iterable)} [arg] - length, typed array, array-like object, buffer, or iterable\n* @param {NonNegativeInteger} [byteOffset=0] - byte offset\n* @param {NonNegativeInteger} [length] - view length\n* @param {Options} [options] - function options\n* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only vector\n* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed vector dimensions\n* @param {string} [options.order='row-major'] - memory layout (either row-major or column-major)\n* @throws {TypeError} first argument must be either a length, typed array, array-like object, buffer, iterable, or options object\n* @throws {TypeError} must provide valid options\n* @returns {ndarray} one-dimensional ndarray\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n*\n* var arr = new Float32Vector();\n* // returns \n*\n* var len = numel( arr );\n* // returns 0\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n*\n* var arr = new Float32Vector( 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n*\n* var arr = new Float32Vector( [ 1.0, 2.0 ] );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf );\n* // returns \n*\n* var len = numel( arr );\n* // returns 8\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf, 16 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 4\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n*\n* var buf = new ArrayBuffer( 64 );\n* var arr = new Float32Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Float32Vector = factory( 'float32' );\n\n\n// EXPORTS //\n\nmodule.exports = Float32Vector;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 vector (i.e., a one-dimensional ndarray).\n*\n* @module @stdlib/ndarray-vector-float32\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var v = new Float32Vector();\n* // returns \n*\n* var len = numel( v );\n* // returns 0\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var v = new Float32Vector( 2 );\n* // returns \n*\n* var len = numel( v );\n* // returns 2\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var v = new Float32Vector( [ 1.0, 2.0 ] );\n* // returns \n*\n* var len = numel( v );\n* // returns 2\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var buf = new ArrayBuffer( 32 );\n* var v = new Float32Vector( buf );\n* // returns \n*\n* var len = numel( v );\n* // returns 8\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var buf = new ArrayBuffer( 32 );\n* var v = new Float32Vector( buf, 16 );\n* // returns \n*\n* var len = numel( v );\n* // returns 4\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var buf = new ArrayBuffer( 64 );\n* var v = new Float32Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( v );\n* // returns 2\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,QAAS,6BAA8B,EAAE,QAiFnDC,EAAgBD,EAAS,SAAU,EAKvCD,EAAO,QAAUE,ICdjB,IAAIC,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "factory", "Float32Vector", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index a92bbdd..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,175 +0,0 @@ - -{{alias}}( [options] ) - Returns a one-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.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A one-dimensional ndarray. - - Examples - -------- - > var arr = {{alias}}() - - - -{{alias}}( length[, options] ) - Returns a one-dimensional single-precision floating-point ndarray having a - specified length. - - Parameters - ---------- - length: integer - 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.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A one-dimensional ndarray. - - Examples - -------- - > var arr = {{alias}}( 5 ) - - > var len = {{alias:@stdlib/ndarray/numel}}( arr ) - 5 - - -{{alias}}( obj[, options] ) - Creates a one-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. - - 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.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A one-dimensional ndarray. - - Examples - -------- - > var v = [ 1.0, 2.0, 3.0 ]; - > var arr = {{alias}}( v ) - - > var len = {{alias:@stdlib/ndarray/numel}}( arr ) - 3 - - -{{alias}}( buffer[, byteOffset[, length]][, options] ) - Returns a one-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. - - length: integer (optional) - View length. If not provided, the view spans from the byteOffset to - the end of the underlying ArrayBuffer. - - 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.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A one-dimensional ndarray. - - Examples - -------- - > var buf = new {{alias:@stdlib/array/buffer}}( 32 ); - > var arr = {{alias}}( buf, 0, 4 ) - - > var len = {{alias:@stdlib/ndarray/numel}}( arr ) - 4 - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index c222353..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,86 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 Float32Vector = require( './index' ); - - -// TESTS // - -// The function returns an ndarray... -{ - new Float32Vector(); // $ExpectType float32ndarray - new Float32Vector( {} ); // $ExpectType float32ndarray - - new Float32Vector( 10 ); // $ExpectType float32ndarray - new Float32Vector( 10, {} ); // $ExpectType float32ndarray - - new Float32Vector( [ 1, 2, 3 ] ); // $ExpectType float32ndarray - new Float32Vector( [ 1, 2, 3 ], {} ); // $ExpectType float32ndarray - - new Float32Vector( new ArrayBuffer( 10 ) ); // $ExpectType float32ndarray - new Float32Vector( new ArrayBuffer( 10 ), {} ); // $ExpectType float32ndarray - - new Float32Vector( new ArrayBuffer( 10 ), 8 ); // $ExpectType float32ndarray - new Float32Vector( new ArrayBuffer( 10 ), 8, {} ); // $ExpectType float32ndarray - - new Float32Vector( new ArrayBuffer( 10 ), 8, 0 ); // $ExpectType float32ndarray - new Float32Vector( new ArrayBuffer( 10 ), 8, 0, {} ); // $ExpectType float32ndarray - - const vector = Float32Vector; - vector(); // $ExpectType float32ndarray - vector( {} ); // $ExpectType float32ndarray - - vector( 10 ); // $ExpectType float32ndarray - vector( 10, {} ); // $ExpectType float32ndarray - - vector( [ 1, 2, 3 ] ); // $ExpectType float32ndarray - vector( [ 1, 2, 3 ], {} ); // $ExpectType float32ndarray - - vector( new ArrayBuffer( 10 ) ); // $ExpectType float32ndarray - vector( new ArrayBuffer( 10 ), {} ); // $ExpectType float32ndarray - - vector( new ArrayBuffer( 10 ), 8 ); // $ExpectType float32ndarray - vector( new ArrayBuffer( 10 ), 8, {} ); // $ExpectType float32ndarray - - vector( new ArrayBuffer( 10 ), 8, 0 ); // $ExpectType float32ndarray - vector( new ArrayBuffer( 10 ), 8, 0, {} ); // $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 Float32Vector( true ); // $ExpectError - new Float32Vector( false ); // $ExpectError - new Float32Vector( null ); // $ExpectError - new Float32Vector( ( x: number ): number => x ); // $ExpectError - - const vector = Float32Vector; - vector( true ); // $ExpectError - vector( false ); // $ExpectError - vector( null ); // $ExpectError - vector( ( 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 Float32Vector( buf, 8, 2, {}, {} ); // $ExpectError - - const vector = Float32Vector; - vector( buf, 8, 2, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 24af996..0000000 --- a/examples/index.js +++ /dev/null @@ -1,43 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 Float32Vector = require( './../lib' ); - -// Create a vector containing random values: -var x = new Float32Vector( discreteUniform( 10, 0, 100 ) ); - -// Compute the sum: -var v = sum( x ); -console.log( v.get() ); - -// 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: -v = sum( y ); -console.log( v.get() ); 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 346c235..fe7ae4c 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 } from '@stdlib/types/ndarray'; import { Collection, AccessorArrayLike } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..83b3e93 --- /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-vector-ctor@v0.1.0-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..0e99e27 --- /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) 2025 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* 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-vector-ctor';\n\n\n// MAIN //\n\n/**\n* Returns a single-precision floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Float32Vector\n* @type {Function}\n* @param {(NonNegativeInteger|Collection|ArrayBuffer|Iterable)} [arg] - length, typed array, array-like object, buffer, or iterable\n* @param {NonNegativeInteger} [byteOffset=0] - byte offset\n* @param {NonNegativeInteger} [length] - view length\n* @param {Options} [options] - function options\n* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only vector\n* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed vector dimensions\n* @param {string} [options.order='row-major'] - memory layout (either row-major or column-major)\n* @throws {TypeError} first argument must be either a length, typed array, array-like object, buffer, iterable, or options object\n* @throws {TypeError} must provide valid options\n* @returns {ndarray} one-dimensional ndarray\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector();\n* // returns \n*\n* var len = numel( arr );\n* // returns 0\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector( 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector( [ 1.0, 2.0 ] );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf );\n* // returns \n*\n* var len = numel( arr );\n* // returns 8\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf, 16 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 4\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 64 );\n* var arr = new Float32Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Float32Vector = factory( 'float32' );\n\n\n// EXPORTS //\n\nexport default Float32Vector;\n"],"names":["Float32Vector","factory"],"mappings":";;yGAuGG,IAACA,EAAgBC,EAAS"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 47c8cc7..0000000 --- a/lib/index.js +++ /dev/null @@ -1,100 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 vector (i.e., a one-dimensional ndarray). -* -* @module @stdlib/ndarray-vector-float32 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var v = new Float32Vector(); -* // returns -* -* var len = numel( v ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var v = new Float32Vector( 2 ); -* // returns -* -* var len = numel( v ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var v = new Float32Vector( [ 1.0, 2.0 ] ); -* // returns -* -* var len = numel( v ); -* // returns 2 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var buf = new ArrayBuffer( 32 ); -* var v = new Float32Vector( buf ); -* // returns -* -* var len = numel( v ); -* // returns 8 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var buf = new ArrayBuffer( 32 ); -* var v = new Float32Vector( buf, 16 ); -* // returns -* -* var len = numel( v ); -* // returns 4 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var buf = new ArrayBuffer( 64 ); -* var v = new Float32Vector( buf, 16, 2 ); -* // returns -* -* var len = numel( v ); -* // returns 2 -*/ - -// 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 853738a..0000000 --- a/lib/main.js +++ /dev/null @@ -1,109 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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-vector-ctor' ).factory; - - -// MAIN // - -/** -* Returns a single-precision floating-point vector (i.e., a one-dimensional ndarray). -* -* @name Float32Vector -* @type {Function} -* @param {(NonNegativeInteger|Collection|ArrayBuffer|Iterable)} [arg] - length, typed array, array-like object, buffer, or iterable -* @param {NonNegativeInteger} [byteOffset=0] - byte offset -* @param {NonNegativeInteger} [length] - view length -* @param {Options} [options] - function options -* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only vector -* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed vector dimensions -* @param {string} [options.order='row-major'] - memory layout (either row-major or column-major) -* @throws {TypeError} first argument must be either a length, typed array, array-like object, buffer, iterable, or options object -* @throws {TypeError} must provide valid options -* @returns {ndarray} one-dimensional ndarray -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector(); -* // returns -* -* var len = numel( arr ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector( 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector( [ 1.0, 2.0 ] ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 32 ); -* var arr = new Float32Vector( buf ); -* // returns -* -* var len = numel( arr ); -* // returns 8 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 32 ); -* var arr = new Float32Vector( buf, 16 ); -* // returns -* -* var len = numel( arr ); -* // returns 4 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 64 ); -* var arr = new Float32Vector( buf, 16, 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -*/ -var Float32Vector = factory( 'float32' ); - - -// EXPORTS // - -module.exports = Float32Vector; diff --git a/package.json b/package.json index 7bd48c3..9eed39e 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.1", "description": "Create a single-precision floating-point vector (i.e., a one-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,45 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/ndarray-vector-ctor": "^0.1.0", - "@stdlib/types": "^0.4.3", - "@stdlib/error-tools-fmtprodmsg": "^0.2.3" - }, - "devDependencies": { - "@stdlib/array-buffer": "^0.2.3", - "@stdlib/array-float32": "^0.2.3", - "@stdlib/array-float64": "^0.2.3", - "@stdlib/assert-is-ndarray-like": "^0.2.2", - "@stdlib/assert-is-ndarray-like-with-data-type": "^0.1.1", - "@stdlib/assert-is-same-float32array": "^0.2.2", - "@stdlib/blas-ext-sum": "^0.1.0", - "@stdlib/buffer-from-array": "^0.2.3", - "@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/random-array-discrete-uniform": "^0.2.2", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.3" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", @@ -92,4 +30,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..f32c9cd --- /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 fff6e0e..0000000 --- a/test/test.js +++ /dev/null @@ -1,1022 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 Float64Array = require( '@stdlib/array-float64' ); -var Float32Array = require( '@stdlib/array-float32' ); -var getData = require( '@stdlib/ndarray-data-buffer' ); -var array2buffer = require( '@stdlib/buffer-from-array' ); -var Float32Vector = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof Float32Vector, '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, - function noop() {} - ]; - for ( i = 0; i < 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 Float32Vector( 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, - function noop() {} - ]; - for ( i = 0; i < 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 Float32Vector( value, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (byteoffset)', 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 Float32Vector( value, 0 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (byteoffset, 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 Float32Vector( value, 0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (byteoffset, length)', 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 Float32Vector( value, 0, 1 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (byteoffset, length, 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 Float32Vector( value, 0, 1, {} ); - }; - } -}); - -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 Float32Vector( 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 Float32Vector( new ArrayBuffer( 8 ), value, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid byte offset argument (length)', 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 Float32Vector( new ArrayBuffer( 8 ), value, 1 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid byte offset argument (length, 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 Float32Vector( new ArrayBuffer( 8 ), value, 1, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid length 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 Float32Vector( new ArrayBuffer( 8 ), 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid length 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 Float32Vector( new ArrayBuffer( 8 ), 0, value, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (length)', 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 Float32Vector( 10, 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 Float32Vector( [], 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 Float32Vector( 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 Float32Vector( new ArrayBuffer( 8 ), 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (arraybuffer, byteoffset, length)', 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 Float32Vector( new ArrayBuffer( 8 ), 0, 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 Float32Vector({ - '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 Float32Vector({ - 'mode': 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 Float32Vector({ - 'readonly': value - }); - }; - } -}); - -tape( 'the function returns a one-dimensional ndarray', function test( t ) { - var arr; - - arr = new Float32Vector(); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - - arr = new Float32Vector( {} ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (length)', function test( t ) { - var arr; - - arr = new Float32Vector( 10 ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, 'returns expected value' ); - - arr = new Float32Vector( 10, {} ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (array)', function test( t ) { - var arr; - var out; - - arr = [ 1.0, 2.0, 3.0, 4.0 ]; - - out = new Float32Vector( arr ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - out = new Float32Vector( arr, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (typed array)', function test( t ) { - var arr; - var out; - - arr = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - out = new Float32Vector( arr ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - out = new Float32Vector( arr, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (buffer)', function test( t ) { - var arr; - var out; - var buf; - - arr = [ 1, 2, 3, 4 ]; - buf = array2buffer( arr ); - - out = new Float32Vector( buf ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - out = new Float32Vector( buf, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (arraybuffer)', function test( t ) { - var buf; - var out; - - buf = new ArrayBuffer( 8 ); - - out = new Float32Vector( buf ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 2, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf ) ), true, 'returns expected value' ); - - out = new Float32Vector( buf, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 2, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (arraybuffer, byteoffset)', function test( t ) { - var buf; - var out; - - buf = new ArrayBuffer( 32 ); - - out = new Float32Vector( buf, 8 ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 6, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf, 8 ) ), true, 'returns expected value' ); - - out = new Float32Vector( buf, 8, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 6, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf, 8 ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (arraybuffer, byteoffset, length)', function test( t ) { - var buf; - var out; - - buf = new ArrayBuffer( 32 ); - - out = new Float32Vector( buf, 8, 2 ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 2, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf, 8, 2 ) ), true, 'returns expected value' ); - - out = new Float32Vector( buf, 8, 2, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 2, '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 Float32Vector({ - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Float32Vector({ - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - t.strictEqual( arr.order, 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (length)', function test( t ) { - var arr; - - arr = new Float32Vector( 10, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Float32Vector( 10, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, 'returns expected value' ); - t.strictEqual( arr.order, 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (array)', function test( t ) { - var arr; - - arr = new Float32Vector( [ 1.0, 2.0, 3.0, 4.0 ], { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 4, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Float32Vector( [ 1.0, 2.0, 3.0, 4.0 ], { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 4, 'returns expected value' ); - t.strictEqual( arr.order, 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (arraybuffer)', function test( t ) { - var arr; - - arr = new Float32Vector( new ArrayBuffer( 32 ), { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 8, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Float32Vector( new ArrayBuffer( 32 ), { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 8, 'returns expected value' ); - t.strictEqual( arr.order, 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (arraybuffer, byteoffset)', function test( t ) { - var arr; - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 6, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 6, 'returns expected value' ); - t.strictEqual( arr.order, 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (arraybuffer, byteoffset, length)', function test( t ) { - var arr; - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, 2, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 2, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, 2, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 2, 'returns expected value' ); - t.strictEqual( arr.order, 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning read-only ndarrays', function test( t ) { - var arr; - - arr = new Float32Vector({ - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning read-only ndarrays (length)', function test( t ) { - var arr; - - arr = new Float32Vector( 10, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, '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 Float32Vector( [ 1.0, 2.0, 3.0, 4.0 ], { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 4, '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 Float32Vector( new ArrayBuffer( 32 ), { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 8, '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 Float32Vector( new ArrayBuffer( 32 ), 8, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 6, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning read-only ndarrays (arraybuffer, byteoffset, length)', function test( t ) { - var arr; - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, 2, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 2, '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 Float32Vector({ - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning writable ndarrays (length)', function test( t ) { - var arr; - - arr = new Float32Vector( 10, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, '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 Float32Vector( [ 1.0, 2.0, 3.0, 4.0 ], { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 4, '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 Float32Vector( new ArrayBuffer( 32 ), { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 8, '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 Float32Vector( new ArrayBuffer( 32 ), 8, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 6, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning writable ndarrays (arraybuffer, byteoffset, length)', function test( t ) { - var arr; - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, 2, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 2, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); From d22fc4c4be1d2576cbcd29aedb72691b3203f36b Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 9 Feb 2026 00:35:07 +0000 Subject: [PATCH 17/42] Update README.md for ESM bundle v0.1.1 --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8906b8b..2804e60 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,7 @@ limitations under the License. ## Usage ```javascript -import Float32Vector from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-vector-float32@esm/index.mjs'; +import Float32Vector from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-vector-float32@v0.1.1-esm/index.mjs'; ``` #### Float32Vector( \[options] ) @@ -161,7 +161,7 @@ var len3 = numel( arr3 ); import discreteUniform from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-discrete-uniform@esm/index.mjs'; import sum from 'https://cdn.jsdelivr.net/gh/stdlib-js/blas-ext-sum@esm/index.mjs'; import map from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-map@esm/index.mjs'; -import Float32Vector from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-vector-float32@esm/index.mjs'; +import Float32Vector from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-vector-float32@v0.1.1-esm/index.mjs'; // Create a vector containing random values: var x = new Float32Vector( discreteUniform( 10, 0, 100 ) ); From 8a4416fd9b7d7f09989619a2dec61fa8faafaa70 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 9 Feb 2026 00:35:07 +0000 Subject: [PATCH 18/42] Auto-generated commit --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2804e60..3f40815 100644 --- a/README.md +++ b/README.md @@ -51,6 +51,11 @@ limitations under the License. ## Usage +```javascript +import Float32Vector from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-vector-float32@esm/index.mjs'; +``` +The previous example will load the latest bundled code from the esm branch. Alternatively, you may load a specific version by loading the file from one of the [tagged bundles](https://github.com/stdlib-js/ndarray-vector-float32/tags). For example, + ```javascript import Float32Vector from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-vector-float32@v0.1.1-esm/index.mjs'; ``` @@ -161,7 +166,7 @@ var len3 = numel( arr3 ); import discreteUniform from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-discrete-uniform@esm/index.mjs'; import sum from 'https://cdn.jsdelivr.net/gh/stdlib-js/blas-ext-sum@esm/index.mjs'; import map from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-map@esm/index.mjs'; -import Float32Vector from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-vector-float32@v0.1.1-esm/index.mjs'; +import Float32Vector from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-vector-float32@esm/index.mjs'; // Create a vector containing random values: var x = new Float32Vector( discreteUniform( 10, 0, 100 ) ); From ad7c2888a56211cce1aa85f4a538e8fef4e833f8 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 2 Mar 2026 01:47:01 +0000 Subject: [PATCH 19/42] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 00bd7a2..467f66b 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/ndarray-vector-ctor": "^0.1.1", - "@stdlib/types": "^0.4.3" + "@stdlib/types": "^0.4.3", + "@stdlib/error-tools-fmtprodmsg": "^0.2.3" }, "devDependencies": { "@stdlib/array-buffer": "^0.2.3", @@ -91,4 +92,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 3fb587ac15836ecbb8322e8ea5f0b96070f09819 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 2 Mar 2026 03:08:53 +0000 Subject: [PATCH 20/42] Remove files --- index.d.ts | 377 ---- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5224 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 fe7ae4c..0000000 --- a/index.d.ts +++ /dev/null @@ -1,377 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 } from '@stdlib/types/ndarray'; -import { Collection, AccessorArrayLike } 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; - - /** - * Boolean indicating whether an array should be read-only (default: false). - */ - readonly?: boolean; -} - -/** -* Interface defining a typed vector constructor which is both "newable" and "callable". -*/ -interface Float32Vector { - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector(); - * // returns - * - * var len = numel( arr ); - * // returns 0 - */ - new ( options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param length - vector length - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector( 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( length: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param obj - array-like object or iterable from which to generate a vector - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector( [ 1.0, 2.0 ] ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( obj: Collection | AccessorArrayLike | Iterable, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Vector( buf ); - * // returns - * - * var len = numel( arr ); - * // returns 8 - */ - new ( buffer: ArrayBuffer, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param byteOffset - integer byte offset specifying the location of the first vector element - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Vector( buf, 8 ); - * // returns - * - * var len = numel( arr ); - * // returns 6 - */ - new ( buffer: ArrayBuffer, byteOffset: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param byteOffset - integer byte offset specifying the location of the first vector element - * @param length - view length; if not provided, the view spans from the byteOffset to the end of the underlying ArrayBuffer - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Vector( buf, 8, 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( buffer: ArrayBuffer, byteOffset: number, length: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector(); - * // returns - * - * var len = numel( arr ); - * // returns 0 - */ - ( options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param length - vector length - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector( 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( length: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param obj - array-like object or iterable from which to generate a vector - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector( [ 1.0, 2.0 ] ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( obj: Collection | AccessorArrayLike | Iterable, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Vector( buf ); - * // returns - * - * var len = numel( arr ); - * // returns 8 - */ - ( buffer: ArrayBuffer, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param byteOffset - integer byte offset specifying the location of the first vector element - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Vector( buf, 8 ); - * // returns - * - * var len = numel( arr ); - * // returns 6 - */ - ( buffer: ArrayBuffer, byteOffset: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param byteOffset - integer byte offset specifying the location of the first vector element - * @param length - view length; if not provided, the view spans from the byteOffset to the end of the underlying ArrayBuffer - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Vector( buf, 8, 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( buffer: ArrayBuffer, byteOffset: number, length: number, options?: Options ): float32ndarray; -} - -/** -* Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). -* -* @param arg - length, typed array, array-like object, buffer, or iterable -* @param byteOffset - integer byte offset specifying the location of the first vector element (default: 0) -* @param length - view length; if not provided, the view spans from the byteOffset to the end of the underlying ArrayBuffer -* @param options - function options -* @param options.readonly - boolean indicating whether to return a read-only vector -* @param options.mode - specifies how to handle indices which exceed vector dimensions -* @param options.order - memory layout (either row-major or column-major) -* @returns one-dimensional ndarray -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector(); -* // returns -* -* var len = numel( arr ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector( 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector( [ 1.0, 2.0 ] ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 32 ); -* var arr = new Float32Vector( buf, 8, 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -*/ -declare var ctor: Float32Vector; - - -// EXPORTS // - -export = ctor; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 83b3e93..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-vector-ctor@v0.1.0-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 0e99e27..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) 2025 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* 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-vector-ctor';\n\n\n// MAIN //\n\n/**\n* Returns a single-precision floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Float32Vector\n* @type {Function}\n* @param {(NonNegativeInteger|Collection|ArrayBuffer|Iterable)} [arg] - length, typed array, array-like object, buffer, or iterable\n* @param {NonNegativeInteger} [byteOffset=0] - byte offset\n* @param {NonNegativeInteger} [length] - view length\n* @param {Options} [options] - function options\n* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only vector\n* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed vector dimensions\n* @param {string} [options.order='row-major'] - memory layout (either row-major or column-major)\n* @throws {TypeError} first argument must be either a length, typed array, array-like object, buffer, iterable, or options object\n* @throws {TypeError} must provide valid options\n* @returns {ndarray} one-dimensional ndarray\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector();\n* // returns \n*\n* var len = numel( arr );\n* // returns 0\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector( 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector( [ 1.0, 2.0 ] );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf );\n* // returns \n*\n* var len = numel( arr );\n* // returns 8\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf, 16 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 4\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 64 );\n* var arr = new Float32Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Float32Vector = factory( 'float32' );\n\n\n// EXPORTS //\n\nexport default Float32Vector;\n"],"names":["Float32Vector","factory"],"mappings":";;yGAuGG,IAACA,EAAgBC,EAAS"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index f32c9cd..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 102b1ed334f64e877b6b333cc15eeaf16e8fabf5 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 2 Mar 2026 03:09:38 +0000 Subject: [PATCH 21/42] Auto-generated commit --- .editorconfig | 180 - .eslintrc.js | 1 - .gitattributes | 66 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 821 --- .github/workflows/publish.yml | 261 - .github/workflows/test.yml | 101 - .github/workflows/test_bundles.yml | 213 - .github/workflows/test_coverage.yml | 142 - .github/workflows/test_install.yml | 94 - .github/workflows/test_published_package.yml | 115 - .gitignore | 199 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 62 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 55 +- SECURITY.md | 5 - benchmark/benchmark.js | 47 - benchmark/benchmark.size.js | 93 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 175 - docs/types/test.ts | 86 - examples/index.js | 43 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 100 - lib/main.js | 109 - package.json | 68 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 1022 ---- 45 files changed, 4874 insertions(+), 5326 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 dab5d2a..0000000 --- a/.editorconfig +++ /dev/null @@ -1,180 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim. - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 1c88e69..0000000 --- a/.gitattributes +++ /dev/null @@ -1,66 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index e71de74..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2026-03-02T01:23:19.530Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index a8a68fb..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/vector/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 f21cc2e..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/vector/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 d88538c..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: '0 0 * * 3' - - # 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 + + ```
@@ -225,7 +216,7 @@ console.log( v.get() ); ## 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]. @@ -288,9 +279,9 @@ Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-vector-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 7418c03..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,47 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* 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 Float32Vector = require( './../lib' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var arr; - var i; - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr = new Float32Vector( 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 46056e3..0000000 --- a/benchmark/benchmark.size.js +++ /dev/null @@ -1,93 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* 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 isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var pkg = require( './../package.json' ).name; -var Float32Vector = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var arr; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr = new Float32Vector( len ); - if ( arr.length !== len ) { - b.fail( 'unexpected length' ); - } - } - 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 len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':size='+len, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 6d01049..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/vector/float32" -%% click B href "https://github.com/stdlib-js/ndarray-vector-float32/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-vector-float32/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-vector-float32/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-vector-float32/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-vector-float32/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/vector/float32 -[production-url]: https://github.com/stdlib-js/ndarray-vector-float32/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-vector-float32/tree/deno -[deno-readme]: https://github.com/stdlib-js/ndarray-vector-float32/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/ndarray-vector-float32/tree/umd -[umd-readme]: https://github.com/stdlib-js/ndarray-vector-float32/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/ndarray-vector-float32/tree/esm -[esm-readme]: https://github.com/stdlib-js/ndarray-vector-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 7c5ecb1..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var o=function(a,r){return function(){return r||a((r={exports:{}}).exports,r),r.exports}};var e=o(function(f,t){ -var s=require('@stdlib/ndarray-vector-ctor/dist').factory,c=s("float32");t.exports=c -});var i=e();module.exports=i; -/** @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 a14f526..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) 2025 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* 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-vector-ctor' ).factory;\n\n\n// MAIN //\n\n/**\n* Returns a single-precision floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Float32Vector\n* @type {Function}\n* @param {(NonNegativeInteger|Collection|ArrayBuffer|Iterable)} [arg] - length, typed array, array-like object, buffer, or iterable\n* @param {NonNegativeInteger} [byteOffset=0] - byte offset\n* @param {NonNegativeInteger} [length] - view length\n* @param {Options} [options] - function options\n* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only vector\n* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed vector dimensions\n* @param {string} [options.order='row-major'] - memory layout (either row-major or column-major)\n* @throws {TypeError} first argument must be either a length, typed array, array-like object, buffer, iterable, or options object\n* @throws {TypeError} must provide valid options\n* @returns {ndarray} one-dimensional ndarray\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n*\n* var arr = new Float32Vector();\n* // returns \n*\n* var len = numel( arr );\n* // returns 0\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n*\n* var arr = new Float32Vector( 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n*\n* var arr = new Float32Vector( [ 1.0, 2.0 ] );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf );\n* // returns \n*\n* var len = numel( arr );\n* // returns 8\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf, 16 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 4\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n*\n* var buf = new ArrayBuffer( 64 );\n* var arr = new Float32Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Float32Vector = factory( 'float32' );\n\n\n// EXPORTS //\n\nmodule.exports = Float32Vector;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 vector (i.e., a one-dimensional ndarray).\n*\n* @module @stdlib/ndarray-vector-float32\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var v = new Float32Vector();\n* // returns \n*\n* var len = numel( v );\n* // returns 0\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var v = new Float32Vector( 2 );\n* // returns \n*\n* var len = numel( v );\n* // returns 2\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var v = new Float32Vector( [ 1.0, 2.0 ] );\n* // returns \n*\n* var len = numel( v );\n* // returns 2\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var buf = new ArrayBuffer( 32 );\n* var v = new Float32Vector( buf );\n* // returns \n*\n* var len = numel( v );\n* // returns 8\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var buf = new ArrayBuffer( 32 );\n* var v = new Float32Vector( buf, 16 );\n* // returns \n*\n* var len = numel( v );\n* // returns 4\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var buf = new ArrayBuffer( 64 );\n* var v = new Float32Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( v );\n* // returns 2\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,QAAS,6BAA8B,EAAE,QAiFnDC,EAAgBD,EAAS,SAAU,EAKvCD,EAAO,QAAUE,ICdjB,IAAIC,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "factory", "Float32Vector", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index a92bbdd..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,175 +0,0 @@ - -{{alias}}( [options] ) - Returns a one-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.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A one-dimensional ndarray. - - Examples - -------- - > var arr = {{alias}}() - - - -{{alias}}( length[, options] ) - Returns a one-dimensional single-precision floating-point ndarray having a - specified length. - - Parameters - ---------- - length: integer - 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.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A one-dimensional ndarray. - - Examples - -------- - > var arr = {{alias}}( 5 ) - - > var len = {{alias:@stdlib/ndarray/numel}}( arr ) - 5 - - -{{alias}}( obj[, options] ) - Creates a one-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. - - 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.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A one-dimensional ndarray. - - Examples - -------- - > var v = [ 1.0, 2.0, 3.0 ]; - > var arr = {{alias}}( v ) - - > var len = {{alias:@stdlib/ndarray/numel}}( arr ) - 3 - - -{{alias}}( buffer[, byteOffset[, length]][, options] ) - Returns a one-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. - - length: integer (optional) - View length. If not provided, the view spans from the byteOffset to - the end of the underlying ArrayBuffer. - - 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.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A one-dimensional ndarray. - - Examples - -------- - > var buf = new {{alias:@stdlib/array/buffer}}( 32 ); - > var arr = {{alias}}( buf, 0, 4 ) - - > var len = {{alias:@stdlib/ndarray/numel}}( arr ) - 4 - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index c222353..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,86 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 Float32Vector = require( './index' ); - - -// TESTS // - -// The function returns an ndarray... -{ - new Float32Vector(); // $ExpectType float32ndarray - new Float32Vector( {} ); // $ExpectType float32ndarray - - new Float32Vector( 10 ); // $ExpectType float32ndarray - new Float32Vector( 10, {} ); // $ExpectType float32ndarray - - new Float32Vector( [ 1, 2, 3 ] ); // $ExpectType float32ndarray - new Float32Vector( [ 1, 2, 3 ], {} ); // $ExpectType float32ndarray - - new Float32Vector( new ArrayBuffer( 10 ) ); // $ExpectType float32ndarray - new Float32Vector( new ArrayBuffer( 10 ), {} ); // $ExpectType float32ndarray - - new Float32Vector( new ArrayBuffer( 10 ), 8 ); // $ExpectType float32ndarray - new Float32Vector( new ArrayBuffer( 10 ), 8, {} ); // $ExpectType float32ndarray - - new Float32Vector( new ArrayBuffer( 10 ), 8, 0 ); // $ExpectType float32ndarray - new Float32Vector( new ArrayBuffer( 10 ), 8, 0, {} ); // $ExpectType float32ndarray - - const vector = Float32Vector; - vector(); // $ExpectType float32ndarray - vector( {} ); // $ExpectType float32ndarray - - vector( 10 ); // $ExpectType float32ndarray - vector( 10, {} ); // $ExpectType float32ndarray - - vector( [ 1, 2, 3 ] ); // $ExpectType float32ndarray - vector( [ 1, 2, 3 ], {} ); // $ExpectType float32ndarray - - vector( new ArrayBuffer( 10 ) ); // $ExpectType float32ndarray - vector( new ArrayBuffer( 10 ), {} ); // $ExpectType float32ndarray - - vector( new ArrayBuffer( 10 ), 8 ); // $ExpectType float32ndarray - vector( new ArrayBuffer( 10 ), 8, {} ); // $ExpectType float32ndarray - - vector( new ArrayBuffer( 10 ), 8, 0 ); // $ExpectType float32ndarray - vector( new ArrayBuffer( 10 ), 8, 0, {} ); // $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 Float32Vector( true ); // $ExpectError - new Float32Vector( false ); // $ExpectError - new Float32Vector( null ); // $ExpectError - new Float32Vector( ( x: number ): number => x ); // $ExpectError - - const vector = Float32Vector; - vector( true ); // $ExpectError - vector( false ); // $ExpectError - vector( null ); // $ExpectError - vector( ( 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 Float32Vector( buf, 8, 2, {}, {} ); // $ExpectError - - const vector = Float32Vector; - vector( buf, 8, 2, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 24af996..0000000 --- a/examples/index.js +++ /dev/null @@ -1,43 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 Float32Vector = require( './../lib' ); - -// Create a vector containing random values: -var x = new Float32Vector( discreteUniform( 10, 0, 100 ) ); - -// Compute the sum: -var v = sum( x ); -console.log( v.get() ); - -// 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: -v = sum( y ); -console.log( v.get() ); 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 346c235..fe7ae4c 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 } from '@stdlib/types/ndarray'; import { Collection, AccessorArrayLike } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..3221a3c --- /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-vector-ctor@v0.1.1-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..0e99e27 --- /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) 2025 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* 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-vector-ctor';\n\n\n// MAIN //\n\n/**\n* Returns a single-precision floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Float32Vector\n* @type {Function}\n* @param {(NonNegativeInteger|Collection|ArrayBuffer|Iterable)} [arg] - length, typed array, array-like object, buffer, or iterable\n* @param {NonNegativeInteger} [byteOffset=0] - byte offset\n* @param {NonNegativeInteger} [length] - view length\n* @param {Options} [options] - function options\n* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only vector\n* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed vector dimensions\n* @param {string} [options.order='row-major'] - memory layout (either row-major or column-major)\n* @throws {TypeError} first argument must be either a length, typed array, array-like object, buffer, iterable, or options object\n* @throws {TypeError} must provide valid options\n* @returns {ndarray} one-dimensional ndarray\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector();\n* // returns \n*\n* var len = numel( arr );\n* // returns 0\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector( 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector( [ 1.0, 2.0 ] );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf );\n* // returns \n*\n* var len = numel( arr );\n* // returns 8\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf, 16 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 4\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 64 );\n* var arr = new Float32Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Float32Vector = factory( 'float32' );\n\n\n// EXPORTS //\n\nexport default Float32Vector;\n"],"names":["Float32Vector","factory"],"mappings":";;yGAuGG,IAACA,EAAgBC,EAAS"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 47c8cc7..0000000 --- a/lib/index.js +++ /dev/null @@ -1,100 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 vector (i.e., a one-dimensional ndarray). -* -* @module @stdlib/ndarray-vector-float32 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var v = new Float32Vector(); -* // returns -* -* var len = numel( v ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var v = new Float32Vector( 2 ); -* // returns -* -* var len = numel( v ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var v = new Float32Vector( [ 1.0, 2.0 ] ); -* // returns -* -* var len = numel( v ); -* // returns 2 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var buf = new ArrayBuffer( 32 ); -* var v = new Float32Vector( buf ); -* // returns -* -* var len = numel( v ); -* // returns 8 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var buf = new ArrayBuffer( 32 ); -* var v = new Float32Vector( buf, 16 ); -* // returns -* -* var len = numel( v ); -* // returns 4 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var buf = new ArrayBuffer( 64 ); -* var v = new Float32Vector( buf, 16, 2 ); -* // returns -* -* var len = numel( v ); -* // returns 2 -*/ - -// 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 853738a..0000000 --- a/lib/main.js +++ /dev/null @@ -1,109 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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-vector-ctor' ).factory; - - -// MAIN // - -/** -* Returns a single-precision floating-point vector (i.e., a one-dimensional ndarray). -* -* @name Float32Vector -* @type {Function} -* @param {(NonNegativeInteger|Collection|ArrayBuffer|Iterable)} [arg] - length, typed array, array-like object, buffer, or iterable -* @param {NonNegativeInteger} [byteOffset=0] - byte offset -* @param {NonNegativeInteger} [length] - view length -* @param {Options} [options] - function options -* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only vector -* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed vector dimensions -* @param {string} [options.order='row-major'] - memory layout (either row-major or column-major) -* @throws {TypeError} first argument must be either a length, typed array, array-like object, buffer, iterable, or options object -* @throws {TypeError} must provide valid options -* @returns {ndarray} one-dimensional ndarray -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector(); -* // returns -* -* var len = numel( arr ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector( 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector( [ 1.0, 2.0 ] ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 32 ); -* var arr = new Float32Vector( buf ); -* // returns -* -* var len = numel( arr ); -* // returns 8 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 32 ); -* var arr = new Float32Vector( buf, 16 ); -* // returns -* -* var len = numel( arr ); -* // returns 4 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 64 ); -* var arr = new Float32Vector( buf, 16, 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -*/ -var Float32Vector = factory( 'float32' ); - - -// EXPORTS // - -module.exports = Float32Vector; diff --git a/package.json b/package.json index 467f66b..9eed39e 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.1", "description": "Create a single-precision floating-point vector (i.e., a one-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,45 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/ndarray-vector-ctor": "^0.1.1", - "@stdlib/types": "^0.4.3", - "@stdlib/error-tools-fmtprodmsg": "^0.2.3" - }, - "devDependencies": { - "@stdlib/array-buffer": "^0.2.3", - "@stdlib/array-float32": "^0.2.3", - "@stdlib/array-float64": "^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/buffer-from-array": "^0.2.3", - "@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/random-array-discrete-uniform": "^0.2.2", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.3" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", @@ -92,4 +30,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..f8585b0 --- /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 fff6e0e..0000000 --- a/test/test.js +++ /dev/null @@ -1,1022 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 Float64Array = require( '@stdlib/array-float64' ); -var Float32Array = require( '@stdlib/array-float32' ); -var getData = require( '@stdlib/ndarray-data-buffer' ); -var array2buffer = require( '@stdlib/buffer-from-array' ); -var Float32Vector = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof Float32Vector, '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, - function noop() {} - ]; - for ( i = 0; i < 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 Float32Vector( 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, - function noop() {} - ]; - for ( i = 0; i < 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 Float32Vector( value, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (byteoffset)', 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 Float32Vector( value, 0 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (byteoffset, 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 Float32Vector( value, 0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (byteoffset, length)', 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 Float32Vector( value, 0, 1 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (byteoffset, length, 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 Float32Vector( value, 0, 1, {} ); - }; - } -}); - -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 Float32Vector( 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 Float32Vector( new ArrayBuffer( 8 ), value, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid byte offset argument (length)', 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 Float32Vector( new ArrayBuffer( 8 ), value, 1 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid byte offset argument (length, 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 Float32Vector( new ArrayBuffer( 8 ), value, 1, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid length 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 Float32Vector( new ArrayBuffer( 8 ), 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid length 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 Float32Vector( new ArrayBuffer( 8 ), 0, value, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (length)', 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 Float32Vector( 10, 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 Float32Vector( [], 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 Float32Vector( 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 Float32Vector( new ArrayBuffer( 8 ), 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (arraybuffer, byteoffset, length)', 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 Float32Vector( new ArrayBuffer( 8 ), 0, 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 Float32Vector({ - '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 Float32Vector({ - 'mode': 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 Float32Vector({ - 'readonly': value - }); - }; - } -}); - -tape( 'the function returns a one-dimensional ndarray', function test( t ) { - var arr; - - arr = new Float32Vector(); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - - arr = new Float32Vector( {} ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (length)', function test( t ) { - var arr; - - arr = new Float32Vector( 10 ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, 'returns expected value' ); - - arr = new Float32Vector( 10, {} ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (array)', function test( t ) { - var arr; - var out; - - arr = [ 1.0, 2.0, 3.0, 4.0 ]; - - out = new Float32Vector( arr ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - out = new Float32Vector( arr, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (typed array)', function test( t ) { - var arr; - var out; - - arr = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - out = new Float32Vector( arr ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - out = new Float32Vector( arr, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (buffer)', function test( t ) { - var arr; - var out; - var buf; - - arr = [ 1, 2, 3, 4 ]; - buf = array2buffer( arr ); - - out = new Float32Vector( buf ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - out = new Float32Vector( buf, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (arraybuffer)', function test( t ) { - var buf; - var out; - - buf = new ArrayBuffer( 8 ); - - out = new Float32Vector( buf ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 2, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf ) ), true, 'returns expected value' ); - - out = new Float32Vector( buf, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 2, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (arraybuffer, byteoffset)', function test( t ) { - var buf; - var out; - - buf = new ArrayBuffer( 32 ); - - out = new Float32Vector( buf, 8 ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 6, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf, 8 ) ), true, 'returns expected value' ); - - out = new Float32Vector( buf, 8, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 6, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf, 8 ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (arraybuffer, byteoffset, length)', function test( t ) { - var buf; - var out; - - buf = new ArrayBuffer( 32 ); - - out = new Float32Vector( buf, 8, 2 ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 2, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf, 8, 2 ) ), true, 'returns expected value' ); - - out = new Float32Vector( buf, 8, 2, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 2, '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 Float32Vector({ - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Float32Vector({ - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - t.strictEqual( arr.order, 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (length)', function test( t ) { - var arr; - - arr = new Float32Vector( 10, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Float32Vector( 10, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, 'returns expected value' ); - t.strictEqual( arr.order, 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (array)', function test( t ) { - var arr; - - arr = new Float32Vector( [ 1.0, 2.0, 3.0, 4.0 ], { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 4, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Float32Vector( [ 1.0, 2.0, 3.0, 4.0 ], { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 4, 'returns expected value' ); - t.strictEqual( arr.order, 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (arraybuffer)', function test( t ) { - var arr; - - arr = new Float32Vector( new ArrayBuffer( 32 ), { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 8, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Float32Vector( new ArrayBuffer( 32 ), { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 8, 'returns expected value' ); - t.strictEqual( arr.order, 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (arraybuffer, byteoffset)', function test( t ) { - var arr; - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 6, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 6, 'returns expected value' ); - t.strictEqual( arr.order, 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (arraybuffer, byteoffset, length)', function test( t ) { - var arr; - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, 2, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 2, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, 2, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 2, 'returns expected value' ); - t.strictEqual( arr.order, 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning read-only ndarrays', function test( t ) { - var arr; - - arr = new Float32Vector({ - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning read-only ndarrays (length)', function test( t ) { - var arr; - - arr = new Float32Vector( 10, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, '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 Float32Vector( [ 1.0, 2.0, 3.0, 4.0 ], { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 4, '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 Float32Vector( new ArrayBuffer( 32 ), { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 8, '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 Float32Vector( new ArrayBuffer( 32 ), 8, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 6, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning read-only ndarrays (arraybuffer, byteoffset, length)', function test( t ) { - var arr; - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, 2, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 2, '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 Float32Vector({ - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning writable ndarrays (length)', function test( t ) { - var arr; - - arr = new Float32Vector( 10, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, '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 Float32Vector( [ 1.0, 2.0, 3.0, 4.0 ], { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 4, '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 Float32Vector( new ArrayBuffer( 32 ), { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 8, '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 Float32Vector( new ArrayBuffer( 32 ), 8, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 6, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning writable ndarrays (arraybuffer, byteoffset, length)', function test( t ) { - var arr; - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, 2, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 2, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); From 0bef796507ff9c0784585833dc016a7c31bb039c Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 16 Mar 2026 01:04:11 +0000 Subject: [PATCH 22/42] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 00bd7a2..467f66b 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/ndarray-vector-ctor": "^0.1.1", - "@stdlib/types": "^0.4.3" + "@stdlib/types": "^0.4.3", + "@stdlib/error-tools-fmtprodmsg": "^0.2.3" }, "devDependencies": { "@stdlib/array-buffer": "^0.2.3", @@ -91,4 +92,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 61f4a978003e63524892212218ea7130c435c174 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 16 Mar 2026 01:30:38 +0000 Subject: [PATCH 23/42] Remove files --- index.d.ts | 377 ---- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5224 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 fe7ae4c..0000000 --- a/index.d.ts +++ /dev/null @@ -1,377 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 } from '@stdlib/types/ndarray'; -import { Collection, AccessorArrayLike } 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; - - /** - * Boolean indicating whether an array should be read-only (default: false). - */ - readonly?: boolean; -} - -/** -* Interface defining a typed vector constructor which is both "newable" and "callable". -*/ -interface Float32Vector { - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector(); - * // returns - * - * var len = numel( arr ); - * // returns 0 - */ - new ( options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param length - vector length - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector( 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( length: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param obj - array-like object or iterable from which to generate a vector - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector( [ 1.0, 2.0 ] ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( obj: Collection | AccessorArrayLike | Iterable, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Vector( buf ); - * // returns - * - * var len = numel( arr ); - * // returns 8 - */ - new ( buffer: ArrayBuffer, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param byteOffset - integer byte offset specifying the location of the first vector element - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Vector( buf, 8 ); - * // returns - * - * var len = numel( arr ); - * // returns 6 - */ - new ( buffer: ArrayBuffer, byteOffset: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param byteOffset - integer byte offset specifying the location of the first vector element - * @param length - view length; if not provided, the view spans from the byteOffset to the end of the underlying ArrayBuffer - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Vector( buf, 8, 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( buffer: ArrayBuffer, byteOffset: number, length: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector(); - * // returns - * - * var len = numel( arr ); - * // returns 0 - */ - ( options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param length - vector length - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector( 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( length: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param obj - array-like object or iterable from which to generate a vector - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector( [ 1.0, 2.0 ] ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( obj: Collection | AccessorArrayLike | Iterable, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Vector( buf ); - * // returns - * - * var len = numel( arr ); - * // returns 8 - */ - ( buffer: ArrayBuffer, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param byteOffset - integer byte offset specifying the location of the first vector element - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Vector( buf, 8 ); - * // returns - * - * var len = numel( arr ); - * // returns 6 - */ - ( buffer: ArrayBuffer, byteOffset: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param byteOffset - integer byte offset specifying the location of the first vector element - * @param length - view length; if not provided, the view spans from the byteOffset to the end of the underlying ArrayBuffer - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Vector( buf, 8, 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( buffer: ArrayBuffer, byteOffset: number, length: number, options?: Options ): float32ndarray; -} - -/** -* Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). -* -* @param arg - length, typed array, array-like object, buffer, or iterable -* @param byteOffset - integer byte offset specifying the location of the first vector element (default: 0) -* @param length - view length; if not provided, the view spans from the byteOffset to the end of the underlying ArrayBuffer -* @param options - function options -* @param options.readonly - boolean indicating whether to return a read-only vector -* @param options.mode - specifies how to handle indices which exceed vector dimensions -* @param options.order - memory layout (either row-major or column-major) -* @returns one-dimensional ndarray -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector(); -* // returns -* -* var len = numel( arr ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector( 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector( [ 1.0, 2.0 ] ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 32 ); -* var arr = new Float32Vector( buf, 8, 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -*/ -declare var ctor: Float32Vector; - - -// EXPORTS // - -export = ctor; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 3221a3c..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-vector-ctor@v0.1.1-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 0e99e27..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) 2025 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* 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-vector-ctor';\n\n\n// MAIN //\n\n/**\n* Returns a single-precision floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Float32Vector\n* @type {Function}\n* @param {(NonNegativeInteger|Collection|ArrayBuffer|Iterable)} [arg] - length, typed array, array-like object, buffer, or iterable\n* @param {NonNegativeInteger} [byteOffset=0] - byte offset\n* @param {NonNegativeInteger} [length] - view length\n* @param {Options} [options] - function options\n* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only vector\n* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed vector dimensions\n* @param {string} [options.order='row-major'] - memory layout (either row-major or column-major)\n* @throws {TypeError} first argument must be either a length, typed array, array-like object, buffer, iterable, or options object\n* @throws {TypeError} must provide valid options\n* @returns {ndarray} one-dimensional ndarray\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector();\n* // returns \n*\n* var len = numel( arr );\n* // returns 0\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector( 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector( [ 1.0, 2.0 ] );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf );\n* // returns \n*\n* var len = numel( arr );\n* // returns 8\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf, 16 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 4\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 64 );\n* var arr = new Float32Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Float32Vector = factory( 'float32' );\n\n\n// EXPORTS //\n\nexport default Float32Vector;\n"],"names":["Float32Vector","factory"],"mappings":";;yGAuGG,IAACA,EAAgBC,EAAS"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index f8585b0..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 2b3f334400fef0fc5e42dd7c27920a87628dc90c Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 16 Mar 2026 01:31:11 +0000 Subject: [PATCH 24/42] Auto-generated commit --- .editorconfig | 180 - .eslintrc.js | 1 - .gitattributes | 66 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 821 --- .github/workflows/publish.yml | 261 - .github/workflows/test.yml | 101 - .github/workflows/test_bundles.yml | 213 - .github/workflows/test_coverage.yml | 142 - .github/workflows/test_install.yml | 94 - .github/workflows/test_published_package.yml | 115 - .gitignore | 199 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 62 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 55 +- SECURITY.md | 5 - benchmark/benchmark.js | 47 - benchmark/benchmark.size.js | 93 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 175 - docs/types/test.ts | 86 - examples/index.js | 43 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 100 - lib/main.js | 109 - package.json | 68 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 1022 ---- 45 files changed, 4874 insertions(+), 5326 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 dab5d2a..0000000 --- a/.editorconfig +++ /dev/null @@ -1,180 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim. - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 1c88e69..0000000 --- a/.gitattributes +++ /dev/null @@ -1,66 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index d4c521a..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2026-03-16T00:57:07.349Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index a8a68fb..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/vector/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 f21cc2e..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/vector/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 d88538c..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: '0 0 * * 3' - - # 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 + + ```
@@ -225,7 +216,7 @@ console.log( v.get() ); ## 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]. @@ -288,9 +279,9 @@ Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-vector-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 7418c03..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,47 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* 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 Float32Vector = require( './../lib' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var arr; - var i; - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr = new Float32Vector( 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 46056e3..0000000 --- a/benchmark/benchmark.size.js +++ /dev/null @@ -1,93 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* 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 isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var pkg = require( './../package.json' ).name; -var Float32Vector = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var arr; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr = new Float32Vector( len ); - if ( arr.length !== len ) { - b.fail( 'unexpected length' ); - } - } - 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 len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':size='+len, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 6d01049..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/vector/float32" -%% click B href "https://github.com/stdlib-js/ndarray-vector-float32/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-vector-float32/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-vector-float32/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-vector-float32/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-vector-float32/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/vector/float32 -[production-url]: https://github.com/stdlib-js/ndarray-vector-float32/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-vector-float32/tree/deno -[deno-readme]: https://github.com/stdlib-js/ndarray-vector-float32/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/ndarray-vector-float32/tree/umd -[umd-readme]: https://github.com/stdlib-js/ndarray-vector-float32/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/ndarray-vector-float32/tree/esm -[esm-readme]: https://github.com/stdlib-js/ndarray-vector-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 7c5ecb1..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var o=function(a,r){return function(){return r||a((r={exports:{}}).exports,r),r.exports}};var e=o(function(f,t){ -var s=require('@stdlib/ndarray-vector-ctor/dist').factory,c=s("float32");t.exports=c -});var i=e();module.exports=i; -/** @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 a14f526..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) 2025 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* 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-vector-ctor' ).factory;\n\n\n// MAIN //\n\n/**\n* Returns a single-precision floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Float32Vector\n* @type {Function}\n* @param {(NonNegativeInteger|Collection|ArrayBuffer|Iterable)} [arg] - length, typed array, array-like object, buffer, or iterable\n* @param {NonNegativeInteger} [byteOffset=0] - byte offset\n* @param {NonNegativeInteger} [length] - view length\n* @param {Options} [options] - function options\n* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only vector\n* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed vector dimensions\n* @param {string} [options.order='row-major'] - memory layout (either row-major or column-major)\n* @throws {TypeError} first argument must be either a length, typed array, array-like object, buffer, iterable, or options object\n* @throws {TypeError} must provide valid options\n* @returns {ndarray} one-dimensional ndarray\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n*\n* var arr = new Float32Vector();\n* // returns \n*\n* var len = numel( arr );\n* // returns 0\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n*\n* var arr = new Float32Vector( 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n*\n* var arr = new Float32Vector( [ 1.0, 2.0 ] );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf );\n* // returns \n*\n* var len = numel( arr );\n* // returns 8\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf, 16 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 4\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n*\n* var buf = new ArrayBuffer( 64 );\n* var arr = new Float32Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Float32Vector = factory( 'float32' );\n\n\n// EXPORTS //\n\nmodule.exports = Float32Vector;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 vector (i.e., a one-dimensional ndarray).\n*\n* @module @stdlib/ndarray-vector-float32\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var v = new Float32Vector();\n* // returns \n*\n* var len = numel( v );\n* // returns 0\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var v = new Float32Vector( 2 );\n* // returns \n*\n* var len = numel( v );\n* // returns 2\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var v = new Float32Vector( [ 1.0, 2.0 ] );\n* // returns \n*\n* var len = numel( v );\n* // returns 2\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var buf = new ArrayBuffer( 32 );\n* var v = new Float32Vector( buf );\n* // returns \n*\n* var len = numel( v );\n* // returns 8\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var buf = new ArrayBuffer( 32 );\n* var v = new Float32Vector( buf, 16 );\n* // returns \n*\n* var len = numel( v );\n* // returns 4\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var buf = new ArrayBuffer( 64 );\n* var v = new Float32Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( v );\n* // returns 2\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,QAAS,6BAA8B,EAAE,QAiFnDC,EAAgBD,EAAS,SAAU,EAKvCD,EAAO,QAAUE,ICdjB,IAAIC,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "factory", "Float32Vector", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index a92bbdd..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,175 +0,0 @@ - -{{alias}}( [options] ) - Returns a one-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.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A one-dimensional ndarray. - - Examples - -------- - > var arr = {{alias}}() - - - -{{alias}}( length[, options] ) - Returns a one-dimensional single-precision floating-point ndarray having a - specified length. - - Parameters - ---------- - length: integer - 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.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A one-dimensional ndarray. - - Examples - -------- - > var arr = {{alias}}( 5 ) - - > var len = {{alias:@stdlib/ndarray/numel}}( arr ) - 5 - - -{{alias}}( obj[, options] ) - Creates a one-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. - - 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.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A one-dimensional ndarray. - - Examples - -------- - > var v = [ 1.0, 2.0, 3.0 ]; - > var arr = {{alias}}( v ) - - > var len = {{alias:@stdlib/ndarray/numel}}( arr ) - 3 - - -{{alias}}( buffer[, byteOffset[, length]][, options] ) - Returns a one-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. - - length: integer (optional) - View length. If not provided, the view spans from the byteOffset to - the end of the underlying ArrayBuffer. - - 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.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A one-dimensional ndarray. - - Examples - -------- - > var buf = new {{alias:@stdlib/array/buffer}}( 32 ); - > var arr = {{alias}}( buf, 0, 4 ) - - > var len = {{alias:@stdlib/ndarray/numel}}( arr ) - 4 - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index c222353..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,86 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 Float32Vector = require( './index' ); - - -// TESTS // - -// The function returns an ndarray... -{ - new Float32Vector(); // $ExpectType float32ndarray - new Float32Vector( {} ); // $ExpectType float32ndarray - - new Float32Vector( 10 ); // $ExpectType float32ndarray - new Float32Vector( 10, {} ); // $ExpectType float32ndarray - - new Float32Vector( [ 1, 2, 3 ] ); // $ExpectType float32ndarray - new Float32Vector( [ 1, 2, 3 ], {} ); // $ExpectType float32ndarray - - new Float32Vector( new ArrayBuffer( 10 ) ); // $ExpectType float32ndarray - new Float32Vector( new ArrayBuffer( 10 ), {} ); // $ExpectType float32ndarray - - new Float32Vector( new ArrayBuffer( 10 ), 8 ); // $ExpectType float32ndarray - new Float32Vector( new ArrayBuffer( 10 ), 8, {} ); // $ExpectType float32ndarray - - new Float32Vector( new ArrayBuffer( 10 ), 8, 0 ); // $ExpectType float32ndarray - new Float32Vector( new ArrayBuffer( 10 ), 8, 0, {} ); // $ExpectType float32ndarray - - const vector = Float32Vector; - vector(); // $ExpectType float32ndarray - vector( {} ); // $ExpectType float32ndarray - - vector( 10 ); // $ExpectType float32ndarray - vector( 10, {} ); // $ExpectType float32ndarray - - vector( [ 1, 2, 3 ] ); // $ExpectType float32ndarray - vector( [ 1, 2, 3 ], {} ); // $ExpectType float32ndarray - - vector( new ArrayBuffer( 10 ) ); // $ExpectType float32ndarray - vector( new ArrayBuffer( 10 ), {} ); // $ExpectType float32ndarray - - vector( new ArrayBuffer( 10 ), 8 ); // $ExpectType float32ndarray - vector( new ArrayBuffer( 10 ), 8, {} ); // $ExpectType float32ndarray - - vector( new ArrayBuffer( 10 ), 8, 0 ); // $ExpectType float32ndarray - vector( new ArrayBuffer( 10 ), 8, 0, {} ); // $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 Float32Vector( true ); // $ExpectError - new Float32Vector( false ); // $ExpectError - new Float32Vector( null ); // $ExpectError - new Float32Vector( ( x: number ): number => x ); // $ExpectError - - const vector = Float32Vector; - vector( true ); // $ExpectError - vector( false ); // $ExpectError - vector( null ); // $ExpectError - vector( ( 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 Float32Vector( buf, 8, 2, {}, {} ); // $ExpectError - - const vector = Float32Vector; - vector( buf, 8, 2, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 24af996..0000000 --- a/examples/index.js +++ /dev/null @@ -1,43 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 Float32Vector = require( './../lib' ); - -// Create a vector containing random values: -var x = new Float32Vector( discreteUniform( 10, 0, 100 ) ); - -// Compute the sum: -var v = sum( x ); -console.log( v.get() ); - -// 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: -v = sum( y ); -console.log( v.get() ); 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 346c235..fe7ae4c 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 } from '@stdlib/types/ndarray'; import { Collection, AccessorArrayLike } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..3221a3c --- /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-vector-ctor@v0.1.1-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..0e99e27 --- /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) 2025 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* 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-vector-ctor';\n\n\n// MAIN //\n\n/**\n* Returns a single-precision floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Float32Vector\n* @type {Function}\n* @param {(NonNegativeInteger|Collection|ArrayBuffer|Iterable)} [arg] - length, typed array, array-like object, buffer, or iterable\n* @param {NonNegativeInteger} [byteOffset=0] - byte offset\n* @param {NonNegativeInteger} [length] - view length\n* @param {Options} [options] - function options\n* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only vector\n* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed vector dimensions\n* @param {string} [options.order='row-major'] - memory layout (either row-major or column-major)\n* @throws {TypeError} first argument must be either a length, typed array, array-like object, buffer, iterable, or options object\n* @throws {TypeError} must provide valid options\n* @returns {ndarray} one-dimensional ndarray\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector();\n* // returns \n*\n* var len = numel( arr );\n* // returns 0\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector( 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector( [ 1.0, 2.0 ] );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf );\n* // returns \n*\n* var len = numel( arr );\n* // returns 8\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf, 16 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 4\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 64 );\n* var arr = new Float32Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Float32Vector = factory( 'float32' );\n\n\n// EXPORTS //\n\nexport default Float32Vector;\n"],"names":["Float32Vector","factory"],"mappings":";;yGAuGG,IAACA,EAAgBC,EAAS"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 47c8cc7..0000000 --- a/lib/index.js +++ /dev/null @@ -1,100 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 vector (i.e., a one-dimensional ndarray). -* -* @module @stdlib/ndarray-vector-float32 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var v = new Float32Vector(); -* // returns -* -* var len = numel( v ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var v = new Float32Vector( 2 ); -* // returns -* -* var len = numel( v ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var v = new Float32Vector( [ 1.0, 2.0 ] ); -* // returns -* -* var len = numel( v ); -* // returns 2 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var buf = new ArrayBuffer( 32 ); -* var v = new Float32Vector( buf ); -* // returns -* -* var len = numel( v ); -* // returns 8 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var buf = new ArrayBuffer( 32 ); -* var v = new Float32Vector( buf, 16 ); -* // returns -* -* var len = numel( v ); -* // returns 4 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var buf = new ArrayBuffer( 64 ); -* var v = new Float32Vector( buf, 16, 2 ); -* // returns -* -* var len = numel( v ); -* // returns 2 -*/ - -// 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 853738a..0000000 --- a/lib/main.js +++ /dev/null @@ -1,109 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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-vector-ctor' ).factory; - - -// MAIN // - -/** -* Returns a single-precision floating-point vector (i.e., a one-dimensional ndarray). -* -* @name Float32Vector -* @type {Function} -* @param {(NonNegativeInteger|Collection|ArrayBuffer|Iterable)} [arg] - length, typed array, array-like object, buffer, or iterable -* @param {NonNegativeInteger} [byteOffset=0] - byte offset -* @param {NonNegativeInteger} [length] - view length -* @param {Options} [options] - function options -* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only vector -* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed vector dimensions -* @param {string} [options.order='row-major'] - memory layout (either row-major or column-major) -* @throws {TypeError} first argument must be either a length, typed array, array-like object, buffer, iterable, or options object -* @throws {TypeError} must provide valid options -* @returns {ndarray} one-dimensional ndarray -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector(); -* // returns -* -* var len = numel( arr ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector( 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector( [ 1.0, 2.0 ] ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 32 ); -* var arr = new Float32Vector( buf ); -* // returns -* -* var len = numel( arr ); -* // returns 8 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 32 ); -* var arr = new Float32Vector( buf, 16 ); -* // returns -* -* var len = numel( arr ); -* // returns 4 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 64 ); -* var arr = new Float32Vector( buf, 16, 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -*/ -var Float32Vector = factory( 'float32' ); - - -// EXPORTS // - -module.exports = Float32Vector; diff --git a/package.json b/package.json index 467f66b..9eed39e 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.1", "description": "Create a single-precision floating-point vector (i.e., a one-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,45 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/ndarray-vector-ctor": "^0.1.1", - "@stdlib/types": "^0.4.3", - "@stdlib/error-tools-fmtprodmsg": "^0.2.3" - }, - "devDependencies": { - "@stdlib/array-buffer": "^0.2.3", - "@stdlib/array-float32": "^0.2.3", - "@stdlib/array-float64": "^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/buffer-from-array": "^0.2.3", - "@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/random-array-discrete-uniform": "^0.2.2", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.3" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", @@ -92,4 +30,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..f8585b0 --- /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 fff6e0e..0000000 --- a/test/test.js +++ /dev/null @@ -1,1022 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 Float64Array = require( '@stdlib/array-float64' ); -var Float32Array = require( '@stdlib/array-float32' ); -var getData = require( '@stdlib/ndarray-data-buffer' ); -var array2buffer = require( '@stdlib/buffer-from-array' ); -var Float32Vector = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof Float32Vector, '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, - function noop() {} - ]; - for ( i = 0; i < 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 Float32Vector( 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, - function noop() {} - ]; - for ( i = 0; i < 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 Float32Vector( value, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (byteoffset)', 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 Float32Vector( value, 0 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (byteoffset, 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 Float32Vector( value, 0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (byteoffset, length)', 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 Float32Vector( value, 0, 1 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (byteoffset, length, 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 Float32Vector( value, 0, 1, {} ); - }; - } -}); - -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 Float32Vector( 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 Float32Vector( new ArrayBuffer( 8 ), value, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid byte offset argument (length)', 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 Float32Vector( new ArrayBuffer( 8 ), value, 1 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid byte offset argument (length, 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 Float32Vector( new ArrayBuffer( 8 ), value, 1, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid length 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 Float32Vector( new ArrayBuffer( 8 ), 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid length 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 Float32Vector( new ArrayBuffer( 8 ), 0, value, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (length)', 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 Float32Vector( 10, 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 Float32Vector( [], 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 Float32Vector( 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 Float32Vector( new ArrayBuffer( 8 ), 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (arraybuffer, byteoffset, length)', 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 Float32Vector( new ArrayBuffer( 8 ), 0, 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 Float32Vector({ - '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 Float32Vector({ - 'mode': 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 Float32Vector({ - 'readonly': value - }); - }; - } -}); - -tape( 'the function returns a one-dimensional ndarray', function test( t ) { - var arr; - - arr = new Float32Vector(); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - - arr = new Float32Vector( {} ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (length)', function test( t ) { - var arr; - - arr = new Float32Vector( 10 ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, 'returns expected value' ); - - arr = new Float32Vector( 10, {} ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (array)', function test( t ) { - var arr; - var out; - - arr = [ 1.0, 2.0, 3.0, 4.0 ]; - - out = new Float32Vector( arr ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - out = new Float32Vector( arr, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (typed array)', function test( t ) { - var arr; - var out; - - arr = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - out = new Float32Vector( arr ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - out = new Float32Vector( arr, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (buffer)', function test( t ) { - var arr; - var out; - var buf; - - arr = [ 1, 2, 3, 4 ]; - buf = array2buffer( arr ); - - out = new Float32Vector( buf ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - out = new Float32Vector( buf, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (arraybuffer)', function test( t ) { - var buf; - var out; - - buf = new ArrayBuffer( 8 ); - - out = new Float32Vector( buf ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 2, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf ) ), true, 'returns expected value' ); - - out = new Float32Vector( buf, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 2, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (arraybuffer, byteoffset)', function test( t ) { - var buf; - var out; - - buf = new ArrayBuffer( 32 ); - - out = new Float32Vector( buf, 8 ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 6, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf, 8 ) ), true, 'returns expected value' ); - - out = new Float32Vector( buf, 8, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 6, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf, 8 ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (arraybuffer, byteoffset, length)', function test( t ) { - var buf; - var out; - - buf = new ArrayBuffer( 32 ); - - out = new Float32Vector( buf, 8, 2 ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 2, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf, 8, 2 ) ), true, 'returns expected value' ); - - out = new Float32Vector( buf, 8, 2, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 2, '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 Float32Vector({ - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Float32Vector({ - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - t.strictEqual( arr.order, 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (length)', function test( t ) { - var arr; - - arr = new Float32Vector( 10, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Float32Vector( 10, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, 'returns expected value' ); - t.strictEqual( arr.order, 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (array)', function test( t ) { - var arr; - - arr = new Float32Vector( [ 1.0, 2.0, 3.0, 4.0 ], { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 4, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Float32Vector( [ 1.0, 2.0, 3.0, 4.0 ], { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 4, 'returns expected value' ); - t.strictEqual( arr.order, 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (arraybuffer)', function test( t ) { - var arr; - - arr = new Float32Vector( new ArrayBuffer( 32 ), { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 8, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Float32Vector( new ArrayBuffer( 32 ), { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 8, 'returns expected value' ); - t.strictEqual( arr.order, 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (arraybuffer, byteoffset)', function test( t ) { - var arr; - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 6, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 6, 'returns expected value' ); - t.strictEqual( arr.order, 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (arraybuffer, byteoffset, length)', function test( t ) { - var arr; - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, 2, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 2, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, 2, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 2, 'returns expected value' ); - t.strictEqual( arr.order, 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning read-only ndarrays', function test( t ) { - var arr; - - arr = new Float32Vector({ - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning read-only ndarrays (length)', function test( t ) { - var arr; - - arr = new Float32Vector( 10, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, '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 Float32Vector( [ 1.0, 2.0, 3.0, 4.0 ], { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 4, '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 Float32Vector( new ArrayBuffer( 32 ), { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 8, '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 Float32Vector( new ArrayBuffer( 32 ), 8, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 6, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning read-only ndarrays (arraybuffer, byteoffset, length)', function test( t ) { - var arr; - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, 2, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 2, '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 Float32Vector({ - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning writable ndarrays (length)', function test( t ) { - var arr; - - arr = new Float32Vector( 10, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, '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 Float32Vector( [ 1.0, 2.0, 3.0, 4.0 ], { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 4, '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 Float32Vector( new ArrayBuffer( 32 ), { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 8, '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 Float32Vector( new ArrayBuffer( 32 ), 8, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 6, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning writable ndarrays (arraybuffer, byteoffset, length)', function test( t ) { - var arr; - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, 2, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 2, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); From ec8545e1341c1c3c3944d29186da36407be4ba9b Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 10 Apr 2026 03:19:46 +0000 Subject: [PATCH 25/42] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 00bd7a2..467f66b 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/ndarray-vector-ctor": "^0.1.1", - "@stdlib/types": "^0.4.3" + "@stdlib/types": "^0.4.3", + "@stdlib/error-tools-fmtprodmsg": "^0.2.3" }, "devDependencies": { "@stdlib/array-buffer": "^0.2.3", @@ -91,4 +92,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 6d42ebdce198fe703b66405e2a08316ef85c9ef9 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 10 Apr 2026 03:27:51 +0000 Subject: [PATCH 26/42] Remove files --- index.d.ts | 377 ---- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5224 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 fe7ae4c..0000000 --- a/index.d.ts +++ /dev/null @@ -1,377 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 } from '@stdlib/types/ndarray'; -import { Collection, AccessorArrayLike } 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; - - /** - * Boolean indicating whether an array should be read-only (default: false). - */ - readonly?: boolean; -} - -/** -* Interface defining a typed vector constructor which is both "newable" and "callable". -*/ -interface Float32Vector { - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector(); - * // returns - * - * var len = numel( arr ); - * // returns 0 - */ - new ( options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param length - vector length - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector( 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( length: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param obj - array-like object or iterable from which to generate a vector - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector( [ 1.0, 2.0 ] ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( obj: Collection | AccessorArrayLike | Iterable, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Vector( buf ); - * // returns - * - * var len = numel( arr ); - * // returns 8 - */ - new ( buffer: ArrayBuffer, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param byteOffset - integer byte offset specifying the location of the first vector element - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Vector( buf, 8 ); - * // returns - * - * var len = numel( arr ); - * // returns 6 - */ - new ( buffer: ArrayBuffer, byteOffset: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param byteOffset - integer byte offset specifying the location of the first vector element - * @param length - view length; if not provided, the view spans from the byteOffset to the end of the underlying ArrayBuffer - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Vector( buf, 8, 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( buffer: ArrayBuffer, byteOffset: number, length: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector(); - * // returns - * - * var len = numel( arr ); - * // returns 0 - */ - ( options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param length - vector length - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector( 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( length: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param obj - array-like object or iterable from which to generate a vector - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector( [ 1.0, 2.0 ] ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( obj: Collection | AccessorArrayLike | Iterable, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Vector( buf ); - * // returns - * - * var len = numel( arr ); - * // returns 8 - */ - ( buffer: ArrayBuffer, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param byteOffset - integer byte offset specifying the location of the first vector element - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Vector( buf, 8 ); - * // returns - * - * var len = numel( arr ); - * // returns 6 - */ - ( buffer: ArrayBuffer, byteOffset: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param byteOffset - integer byte offset specifying the location of the first vector element - * @param length - view length; if not provided, the view spans from the byteOffset to the end of the underlying ArrayBuffer - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Vector( buf, 8, 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( buffer: ArrayBuffer, byteOffset: number, length: number, options?: Options ): float32ndarray; -} - -/** -* Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). -* -* @param arg - length, typed array, array-like object, buffer, or iterable -* @param byteOffset - integer byte offset specifying the location of the first vector element (default: 0) -* @param length - view length; if not provided, the view spans from the byteOffset to the end of the underlying ArrayBuffer -* @param options - function options -* @param options.readonly - boolean indicating whether to return a read-only vector -* @param options.mode - specifies how to handle indices which exceed vector dimensions -* @param options.order - memory layout (either row-major or column-major) -* @returns one-dimensional ndarray -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector(); -* // returns -* -* var len = numel( arr ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector( 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector( [ 1.0, 2.0 ] ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 32 ); -* var arr = new Float32Vector( buf, 8, 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -*/ -declare var ctor: Float32Vector; - - -// EXPORTS // - -export = ctor; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 3221a3c..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-vector-ctor@v0.1.1-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 0e99e27..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) 2025 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* 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-vector-ctor';\n\n\n// MAIN //\n\n/**\n* Returns a single-precision floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Float32Vector\n* @type {Function}\n* @param {(NonNegativeInteger|Collection|ArrayBuffer|Iterable)} [arg] - length, typed array, array-like object, buffer, or iterable\n* @param {NonNegativeInteger} [byteOffset=0] - byte offset\n* @param {NonNegativeInteger} [length] - view length\n* @param {Options} [options] - function options\n* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only vector\n* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed vector dimensions\n* @param {string} [options.order='row-major'] - memory layout (either row-major or column-major)\n* @throws {TypeError} first argument must be either a length, typed array, array-like object, buffer, iterable, or options object\n* @throws {TypeError} must provide valid options\n* @returns {ndarray} one-dimensional ndarray\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector();\n* // returns \n*\n* var len = numel( arr );\n* // returns 0\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector( 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector( [ 1.0, 2.0 ] );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf );\n* // returns \n*\n* var len = numel( arr );\n* // returns 8\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf, 16 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 4\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 64 );\n* var arr = new Float32Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Float32Vector = factory( 'float32' );\n\n\n// EXPORTS //\n\nexport default Float32Vector;\n"],"names":["Float32Vector","factory"],"mappings":";;yGAuGG,IAACA,EAAgBC,EAAS"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index f8585b0..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 0e8652dbb6b22d178bb7abe920b9061d2ba61a2e Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 10 Apr 2026 03:28:29 +0000 Subject: [PATCH 27/42] Auto-generated commit --- .editorconfig | 189 - .eslintrc.js | 1 - .gitattributes | 68 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 821 --- .github/workflows/publish.yml | 261 - .github/workflows/test.yml | 101 - .github/workflows/test_bundles.yml | 213 - .github/workflows/test_coverage.yml | 142 - .github/workflows/test_install.yml | 94 - .github/workflows/test_published_package.yml | 115 - .gitignore | 199 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 62 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 55 +- SECURITY.md | 5 - benchmark/benchmark.js | 47 - benchmark/benchmark.size.js | 93 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 175 - docs/types/test.ts | 86 - examples/index.js | 43 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 100 - lib/main.js | 109 - package.json | 68 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 1022 ---- 45 files changed, 4874 insertions(+), 5337 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 48e4ee2..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2026-04-10T03:17:59.895Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index a8a68fb..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/vector/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 f21cc2e..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/vector/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 d88538c..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: '0 0 * * 3' - - # 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 + + ```
@@ -225,7 +216,7 @@ console.log( v.get() ); ## 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]. @@ -288,9 +279,9 @@ Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-vector-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 7418c03..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,47 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* 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 Float32Vector = require( './../lib' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var arr; - var i; - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr = new Float32Vector( 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 46056e3..0000000 --- a/benchmark/benchmark.size.js +++ /dev/null @@ -1,93 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* 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 isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var pkg = require( './../package.json' ).name; -var Float32Vector = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var arr; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr = new Float32Vector( len ); - if ( arr.length !== len ) { - b.fail( 'unexpected length' ); - } - } - 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 len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':size='+len, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 6d01049..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/vector/float32" -%% click B href "https://github.com/stdlib-js/ndarray-vector-float32/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-vector-float32/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-vector-float32/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-vector-float32/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-vector-float32/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/vector/float32 -[production-url]: https://github.com/stdlib-js/ndarray-vector-float32/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-vector-float32/tree/deno -[deno-readme]: https://github.com/stdlib-js/ndarray-vector-float32/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/ndarray-vector-float32/tree/umd -[umd-readme]: https://github.com/stdlib-js/ndarray-vector-float32/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/ndarray-vector-float32/tree/esm -[esm-readme]: https://github.com/stdlib-js/ndarray-vector-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 7c5ecb1..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var o=function(a,r){return function(){return r||a((r={exports:{}}).exports,r),r.exports}};var e=o(function(f,t){ -var s=require('@stdlib/ndarray-vector-ctor/dist').factory,c=s("float32");t.exports=c -});var i=e();module.exports=i; -/** @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 a14f526..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) 2025 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* 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-vector-ctor' ).factory;\n\n\n// MAIN //\n\n/**\n* Returns a single-precision floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Float32Vector\n* @type {Function}\n* @param {(NonNegativeInteger|Collection|ArrayBuffer|Iterable)} [arg] - length, typed array, array-like object, buffer, or iterable\n* @param {NonNegativeInteger} [byteOffset=0] - byte offset\n* @param {NonNegativeInteger} [length] - view length\n* @param {Options} [options] - function options\n* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only vector\n* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed vector dimensions\n* @param {string} [options.order='row-major'] - memory layout (either row-major or column-major)\n* @throws {TypeError} first argument must be either a length, typed array, array-like object, buffer, iterable, or options object\n* @throws {TypeError} must provide valid options\n* @returns {ndarray} one-dimensional ndarray\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n*\n* var arr = new Float32Vector();\n* // returns \n*\n* var len = numel( arr );\n* // returns 0\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n*\n* var arr = new Float32Vector( 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n*\n* var arr = new Float32Vector( [ 1.0, 2.0 ] );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf );\n* // returns \n*\n* var len = numel( arr );\n* // returns 8\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf, 16 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 4\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n*\n* var buf = new ArrayBuffer( 64 );\n* var arr = new Float32Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Float32Vector = factory( 'float32' );\n\n\n// EXPORTS //\n\nmodule.exports = Float32Vector;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 vector (i.e., a one-dimensional ndarray).\n*\n* @module @stdlib/ndarray-vector-float32\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var v = new Float32Vector();\n* // returns \n*\n* var len = numel( v );\n* // returns 0\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var v = new Float32Vector( 2 );\n* // returns \n*\n* var len = numel( v );\n* // returns 2\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var v = new Float32Vector( [ 1.0, 2.0 ] );\n* // returns \n*\n* var len = numel( v );\n* // returns 2\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var buf = new ArrayBuffer( 32 );\n* var v = new Float32Vector( buf );\n* // returns \n*\n* var len = numel( v );\n* // returns 8\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var buf = new ArrayBuffer( 32 );\n* var v = new Float32Vector( buf, 16 );\n* // returns \n*\n* var len = numel( v );\n* // returns 4\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var buf = new ArrayBuffer( 64 );\n* var v = new Float32Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( v );\n* // returns 2\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,QAAS,6BAA8B,EAAE,QAiFnDC,EAAgBD,EAAS,SAAU,EAKvCD,EAAO,QAAUE,ICdjB,IAAIC,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "factory", "Float32Vector", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index a92bbdd..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,175 +0,0 @@ - -{{alias}}( [options] ) - Returns a one-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.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A one-dimensional ndarray. - - Examples - -------- - > var arr = {{alias}}() - - - -{{alias}}( length[, options] ) - Returns a one-dimensional single-precision floating-point ndarray having a - specified length. - - Parameters - ---------- - length: integer - 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.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A one-dimensional ndarray. - - Examples - -------- - > var arr = {{alias}}( 5 ) - - > var len = {{alias:@stdlib/ndarray/numel}}( arr ) - 5 - - -{{alias}}( obj[, options] ) - Creates a one-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. - - 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.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A one-dimensional ndarray. - - Examples - -------- - > var v = [ 1.0, 2.0, 3.0 ]; - > var arr = {{alias}}( v ) - - > var len = {{alias:@stdlib/ndarray/numel}}( arr ) - 3 - - -{{alias}}( buffer[, byteOffset[, length]][, options] ) - Returns a one-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. - - length: integer (optional) - View length. If not provided, the view spans from the byteOffset to - the end of the underlying ArrayBuffer. - - 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.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A one-dimensional ndarray. - - Examples - -------- - > var buf = new {{alias:@stdlib/array/buffer}}( 32 ); - > var arr = {{alias}}( buf, 0, 4 ) - - > var len = {{alias:@stdlib/ndarray/numel}}( arr ) - 4 - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index c222353..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,86 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 Float32Vector = require( './index' ); - - -// TESTS // - -// The function returns an ndarray... -{ - new Float32Vector(); // $ExpectType float32ndarray - new Float32Vector( {} ); // $ExpectType float32ndarray - - new Float32Vector( 10 ); // $ExpectType float32ndarray - new Float32Vector( 10, {} ); // $ExpectType float32ndarray - - new Float32Vector( [ 1, 2, 3 ] ); // $ExpectType float32ndarray - new Float32Vector( [ 1, 2, 3 ], {} ); // $ExpectType float32ndarray - - new Float32Vector( new ArrayBuffer( 10 ) ); // $ExpectType float32ndarray - new Float32Vector( new ArrayBuffer( 10 ), {} ); // $ExpectType float32ndarray - - new Float32Vector( new ArrayBuffer( 10 ), 8 ); // $ExpectType float32ndarray - new Float32Vector( new ArrayBuffer( 10 ), 8, {} ); // $ExpectType float32ndarray - - new Float32Vector( new ArrayBuffer( 10 ), 8, 0 ); // $ExpectType float32ndarray - new Float32Vector( new ArrayBuffer( 10 ), 8, 0, {} ); // $ExpectType float32ndarray - - const vector = Float32Vector; - vector(); // $ExpectType float32ndarray - vector( {} ); // $ExpectType float32ndarray - - vector( 10 ); // $ExpectType float32ndarray - vector( 10, {} ); // $ExpectType float32ndarray - - vector( [ 1, 2, 3 ] ); // $ExpectType float32ndarray - vector( [ 1, 2, 3 ], {} ); // $ExpectType float32ndarray - - vector( new ArrayBuffer( 10 ) ); // $ExpectType float32ndarray - vector( new ArrayBuffer( 10 ), {} ); // $ExpectType float32ndarray - - vector( new ArrayBuffer( 10 ), 8 ); // $ExpectType float32ndarray - vector( new ArrayBuffer( 10 ), 8, {} ); // $ExpectType float32ndarray - - vector( new ArrayBuffer( 10 ), 8, 0 ); // $ExpectType float32ndarray - vector( new ArrayBuffer( 10 ), 8, 0, {} ); // $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 Float32Vector( true ); // $ExpectError - new Float32Vector( false ); // $ExpectError - new Float32Vector( null ); // $ExpectError - new Float32Vector( ( x: number ): number => x ); // $ExpectError - - const vector = Float32Vector; - vector( true ); // $ExpectError - vector( false ); // $ExpectError - vector( null ); // $ExpectError - vector( ( 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 Float32Vector( buf, 8, 2, {}, {} ); // $ExpectError - - const vector = Float32Vector; - vector( buf, 8, 2, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 24af996..0000000 --- a/examples/index.js +++ /dev/null @@ -1,43 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 Float32Vector = require( './../lib' ); - -// Create a vector containing random values: -var x = new Float32Vector( discreteUniform( 10, 0, 100 ) ); - -// Compute the sum: -var v = sum( x ); -console.log( v.get() ); - -// 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: -v = sum( y ); -console.log( v.get() ); 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 346c235..fe7ae4c 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 } from '@stdlib/types/ndarray'; import { Collection, AccessorArrayLike } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..3221a3c --- /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-vector-ctor@v0.1.1-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..0e99e27 --- /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) 2025 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* 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-vector-ctor';\n\n\n// MAIN //\n\n/**\n* Returns a single-precision floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Float32Vector\n* @type {Function}\n* @param {(NonNegativeInteger|Collection|ArrayBuffer|Iterable)} [arg] - length, typed array, array-like object, buffer, or iterable\n* @param {NonNegativeInteger} [byteOffset=0] - byte offset\n* @param {NonNegativeInteger} [length] - view length\n* @param {Options} [options] - function options\n* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only vector\n* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed vector dimensions\n* @param {string} [options.order='row-major'] - memory layout (either row-major or column-major)\n* @throws {TypeError} first argument must be either a length, typed array, array-like object, buffer, iterable, or options object\n* @throws {TypeError} must provide valid options\n* @returns {ndarray} one-dimensional ndarray\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector();\n* // returns \n*\n* var len = numel( arr );\n* // returns 0\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector( 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector( [ 1.0, 2.0 ] );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf );\n* // returns \n*\n* var len = numel( arr );\n* // returns 8\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf, 16 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 4\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 64 );\n* var arr = new Float32Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Float32Vector = factory( 'float32' );\n\n\n// EXPORTS //\n\nexport default Float32Vector;\n"],"names":["Float32Vector","factory"],"mappings":";;yGAuGG,IAACA,EAAgBC,EAAS"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 47c8cc7..0000000 --- a/lib/index.js +++ /dev/null @@ -1,100 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 vector (i.e., a one-dimensional ndarray). -* -* @module @stdlib/ndarray-vector-float32 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var v = new Float32Vector(); -* // returns -* -* var len = numel( v ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var v = new Float32Vector( 2 ); -* // returns -* -* var len = numel( v ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var v = new Float32Vector( [ 1.0, 2.0 ] ); -* // returns -* -* var len = numel( v ); -* // returns 2 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var buf = new ArrayBuffer( 32 ); -* var v = new Float32Vector( buf ); -* // returns -* -* var len = numel( v ); -* // returns 8 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var buf = new ArrayBuffer( 32 ); -* var v = new Float32Vector( buf, 16 ); -* // returns -* -* var len = numel( v ); -* // returns 4 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var buf = new ArrayBuffer( 64 ); -* var v = new Float32Vector( buf, 16, 2 ); -* // returns -* -* var len = numel( v ); -* // returns 2 -*/ - -// 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 853738a..0000000 --- a/lib/main.js +++ /dev/null @@ -1,109 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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-vector-ctor' ).factory; - - -// MAIN // - -/** -* Returns a single-precision floating-point vector (i.e., a one-dimensional ndarray). -* -* @name Float32Vector -* @type {Function} -* @param {(NonNegativeInteger|Collection|ArrayBuffer|Iterable)} [arg] - length, typed array, array-like object, buffer, or iterable -* @param {NonNegativeInteger} [byteOffset=0] - byte offset -* @param {NonNegativeInteger} [length] - view length -* @param {Options} [options] - function options -* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only vector -* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed vector dimensions -* @param {string} [options.order='row-major'] - memory layout (either row-major or column-major) -* @throws {TypeError} first argument must be either a length, typed array, array-like object, buffer, iterable, or options object -* @throws {TypeError} must provide valid options -* @returns {ndarray} one-dimensional ndarray -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector(); -* // returns -* -* var len = numel( arr ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector( 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector( [ 1.0, 2.0 ] ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 32 ); -* var arr = new Float32Vector( buf ); -* // returns -* -* var len = numel( arr ); -* // returns 8 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 32 ); -* var arr = new Float32Vector( buf, 16 ); -* // returns -* -* var len = numel( arr ); -* // returns 4 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 64 ); -* var arr = new Float32Vector( buf, 16, 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -*/ -var Float32Vector = factory( 'float32' ); - - -// EXPORTS // - -module.exports = Float32Vector; diff --git a/package.json b/package.json index 467f66b..9eed39e 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.1", "description": "Create a single-precision floating-point vector (i.e., a one-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,45 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/ndarray-vector-ctor": "^0.1.1", - "@stdlib/types": "^0.4.3", - "@stdlib/error-tools-fmtprodmsg": "^0.2.3" - }, - "devDependencies": { - "@stdlib/array-buffer": "^0.2.3", - "@stdlib/array-float32": "^0.2.3", - "@stdlib/array-float64": "^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/buffer-from-array": "^0.2.3", - "@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/random-array-discrete-uniform": "^0.2.2", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.3" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", @@ -92,4 +30,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..f8585b0 --- /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 fff6e0e..0000000 --- a/test/test.js +++ /dev/null @@ -1,1022 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 Float64Array = require( '@stdlib/array-float64' ); -var Float32Array = require( '@stdlib/array-float32' ); -var getData = require( '@stdlib/ndarray-data-buffer' ); -var array2buffer = require( '@stdlib/buffer-from-array' ); -var Float32Vector = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof Float32Vector, '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, - function noop() {} - ]; - for ( i = 0; i < 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 Float32Vector( 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, - function noop() {} - ]; - for ( i = 0; i < 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 Float32Vector( value, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (byteoffset)', 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 Float32Vector( value, 0 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (byteoffset, 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 Float32Vector( value, 0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (byteoffset, length)', 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 Float32Vector( value, 0, 1 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (byteoffset, length, 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 Float32Vector( value, 0, 1, {} ); - }; - } -}); - -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 Float32Vector( 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 Float32Vector( new ArrayBuffer( 8 ), value, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid byte offset argument (length)', 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 Float32Vector( new ArrayBuffer( 8 ), value, 1 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid byte offset argument (length, 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 Float32Vector( new ArrayBuffer( 8 ), value, 1, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid length 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 Float32Vector( new ArrayBuffer( 8 ), 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid length 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 Float32Vector( new ArrayBuffer( 8 ), 0, value, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (length)', 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 Float32Vector( 10, 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 Float32Vector( [], 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 Float32Vector( 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 Float32Vector( new ArrayBuffer( 8 ), 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (arraybuffer, byteoffset, length)', 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 Float32Vector( new ArrayBuffer( 8 ), 0, 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 Float32Vector({ - '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 Float32Vector({ - 'mode': 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 Float32Vector({ - 'readonly': value - }); - }; - } -}); - -tape( 'the function returns a one-dimensional ndarray', function test( t ) { - var arr; - - arr = new Float32Vector(); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - - arr = new Float32Vector( {} ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (length)', function test( t ) { - var arr; - - arr = new Float32Vector( 10 ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, 'returns expected value' ); - - arr = new Float32Vector( 10, {} ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (array)', function test( t ) { - var arr; - var out; - - arr = [ 1.0, 2.0, 3.0, 4.0 ]; - - out = new Float32Vector( arr ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - out = new Float32Vector( arr, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (typed array)', function test( t ) { - var arr; - var out; - - arr = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - out = new Float32Vector( arr ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - out = new Float32Vector( arr, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (buffer)', function test( t ) { - var arr; - var out; - var buf; - - arr = [ 1, 2, 3, 4 ]; - buf = array2buffer( arr ); - - out = new Float32Vector( buf ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - out = new Float32Vector( buf, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (arraybuffer)', function test( t ) { - var buf; - var out; - - buf = new ArrayBuffer( 8 ); - - out = new Float32Vector( buf ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 2, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf ) ), true, 'returns expected value' ); - - out = new Float32Vector( buf, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 2, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (arraybuffer, byteoffset)', function test( t ) { - var buf; - var out; - - buf = new ArrayBuffer( 32 ); - - out = new Float32Vector( buf, 8 ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 6, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf, 8 ) ), true, 'returns expected value' ); - - out = new Float32Vector( buf, 8, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 6, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf, 8 ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (arraybuffer, byteoffset, length)', function test( t ) { - var buf; - var out; - - buf = new ArrayBuffer( 32 ); - - out = new Float32Vector( buf, 8, 2 ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 2, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf, 8, 2 ) ), true, 'returns expected value' ); - - out = new Float32Vector( buf, 8, 2, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 2, '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 Float32Vector({ - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Float32Vector({ - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - t.strictEqual( arr.order, 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (length)', function test( t ) { - var arr; - - arr = new Float32Vector( 10, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Float32Vector( 10, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, 'returns expected value' ); - t.strictEqual( arr.order, 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (array)', function test( t ) { - var arr; - - arr = new Float32Vector( [ 1.0, 2.0, 3.0, 4.0 ], { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 4, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Float32Vector( [ 1.0, 2.0, 3.0, 4.0 ], { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 4, 'returns expected value' ); - t.strictEqual( arr.order, 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (arraybuffer)', function test( t ) { - var arr; - - arr = new Float32Vector( new ArrayBuffer( 32 ), { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 8, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Float32Vector( new ArrayBuffer( 32 ), { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 8, 'returns expected value' ); - t.strictEqual( arr.order, 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (arraybuffer, byteoffset)', function test( t ) { - var arr; - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 6, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 6, 'returns expected value' ); - t.strictEqual( arr.order, 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (arraybuffer, byteoffset, length)', function test( t ) { - var arr; - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, 2, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 2, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, 2, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 2, 'returns expected value' ); - t.strictEqual( arr.order, 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning read-only ndarrays', function test( t ) { - var arr; - - arr = new Float32Vector({ - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning read-only ndarrays (length)', function test( t ) { - var arr; - - arr = new Float32Vector( 10, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, '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 Float32Vector( [ 1.0, 2.0, 3.0, 4.0 ], { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 4, '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 Float32Vector( new ArrayBuffer( 32 ), { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 8, '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 Float32Vector( new ArrayBuffer( 32 ), 8, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 6, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning read-only ndarrays (arraybuffer, byteoffset, length)', function test( t ) { - var arr; - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, 2, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 2, '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 Float32Vector({ - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning writable ndarrays (length)', function test( t ) { - var arr; - - arr = new Float32Vector( 10, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, '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 Float32Vector( [ 1.0, 2.0, 3.0, 4.0 ], { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 4, '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 Float32Vector( new ArrayBuffer( 32 ), { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 8, '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 Float32Vector( new ArrayBuffer( 32 ), 8, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 6, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning writable ndarrays (arraybuffer, byteoffset, length)', function test( t ) { - var arr; - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, 2, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 2, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); From e4b82d728fae4d261754d6bc9a832f9f45400ac4 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 21 Apr 2026 04:35:30 +0000 Subject: [PATCH 28/42] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 176d911..515f06f 100644 --- a/package.json +++ b/package.json @@ -54,7 +54,7 @@ "@stdlib/ndarray-data-buffer": "^0.2.3", "@stdlib/ndarray-map": "^0.1.1", "@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 4123331c0ad3709c1ece1a84ecdad6590db90589 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 21 Apr 2026 05:29:46 +0000 Subject: [PATCH 29/42] Remove files --- index.d.ts | 377 ---- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5224 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 fe7ae4c..0000000 --- a/index.d.ts +++ /dev/null @@ -1,377 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 } from '@stdlib/types/ndarray'; -import { Collection, AccessorArrayLike } 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; - - /** - * Boolean indicating whether an array should be read-only (default: false). - */ - readonly?: boolean; -} - -/** -* Interface defining a typed vector constructor which is both "newable" and "callable". -*/ -interface Float32Vector { - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector(); - * // returns - * - * var len = numel( arr ); - * // returns 0 - */ - new ( options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param length - vector length - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector( 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( length: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param obj - array-like object or iterable from which to generate a vector - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector( [ 1.0, 2.0 ] ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( obj: Collection | AccessorArrayLike | Iterable, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Vector( buf ); - * // returns - * - * var len = numel( arr ); - * // returns 8 - */ - new ( buffer: ArrayBuffer, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param byteOffset - integer byte offset specifying the location of the first vector element - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Vector( buf, 8 ); - * // returns - * - * var len = numel( arr ); - * // returns 6 - */ - new ( buffer: ArrayBuffer, byteOffset: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param byteOffset - integer byte offset specifying the location of the first vector element - * @param length - view length; if not provided, the view spans from the byteOffset to the end of the underlying ArrayBuffer - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Vector( buf, 8, 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( buffer: ArrayBuffer, byteOffset: number, length: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector(); - * // returns - * - * var len = numel( arr ); - * // returns 0 - */ - ( options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param length - vector length - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector( 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( length: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param obj - array-like object or iterable from which to generate a vector - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector( [ 1.0, 2.0 ] ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( obj: Collection | AccessorArrayLike | Iterable, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Vector( buf ); - * // returns - * - * var len = numel( arr ); - * // returns 8 - */ - ( buffer: ArrayBuffer, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param byteOffset - integer byte offset specifying the location of the first vector element - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Vector( buf, 8 ); - * // returns - * - * var len = numel( arr ); - * // returns 6 - */ - ( buffer: ArrayBuffer, byteOffset: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param byteOffset - integer byte offset specifying the location of the first vector element - * @param length - view length; if not provided, the view spans from the byteOffset to the end of the underlying ArrayBuffer - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Vector( buf, 8, 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( buffer: ArrayBuffer, byteOffset: number, length: number, options?: Options ): float32ndarray; -} - -/** -* Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). -* -* @param arg - length, typed array, array-like object, buffer, or iterable -* @param byteOffset - integer byte offset specifying the location of the first vector element (default: 0) -* @param length - view length; if not provided, the view spans from the byteOffset to the end of the underlying ArrayBuffer -* @param options - function options -* @param options.readonly - boolean indicating whether to return a read-only vector -* @param options.mode - specifies how to handle indices which exceed vector dimensions -* @param options.order - memory layout (either row-major or column-major) -* @returns one-dimensional ndarray -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector(); -* // returns -* -* var len = numel( arr ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector( 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector( [ 1.0, 2.0 ] ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 32 ); -* var arr = new Float32Vector( buf, 8, 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -*/ -declare var ctor: Float32Vector; - - -// EXPORTS // - -export = ctor; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 3221a3c..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-vector-ctor@v0.1.1-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 0e99e27..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) 2025 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* 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-vector-ctor';\n\n\n// MAIN //\n\n/**\n* Returns a single-precision floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Float32Vector\n* @type {Function}\n* @param {(NonNegativeInteger|Collection|ArrayBuffer|Iterable)} [arg] - length, typed array, array-like object, buffer, or iterable\n* @param {NonNegativeInteger} [byteOffset=0] - byte offset\n* @param {NonNegativeInteger} [length] - view length\n* @param {Options} [options] - function options\n* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only vector\n* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed vector dimensions\n* @param {string} [options.order='row-major'] - memory layout (either row-major or column-major)\n* @throws {TypeError} first argument must be either a length, typed array, array-like object, buffer, iterable, or options object\n* @throws {TypeError} must provide valid options\n* @returns {ndarray} one-dimensional ndarray\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector();\n* // returns \n*\n* var len = numel( arr );\n* // returns 0\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector( 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector( [ 1.0, 2.0 ] );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf );\n* // returns \n*\n* var len = numel( arr );\n* // returns 8\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf, 16 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 4\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 64 );\n* var arr = new Float32Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Float32Vector = factory( 'float32' );\n\n\n// EXPORTS //\n\nexport default Float32Vector;\n"],"names":["Float32Vector","factory"],"mappings":";;yGAuGG,IAACA,EAAgBC,EAAS"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index f8585b0..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 4b94567e7dd49cb90f3b97e765f1f11be0638ed0 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 21 Apr 2026 05:30:17 +0000 Subject: [PATCH 30/42] Auto-generated commit --- .editorconfig | 189 - .eslintrc.js | 1 - .gitattributes | 68 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 821 --- .github/workflows/publish.yml | 261 - .github/workflows/test.yml | 101 - .github/workflows/test_bundles.yml | 213 - .github/workflows/test_coverage.yml | 142 - .github/workflows/test_install.yml | 94 - .github/workflows/test_published_package.yml | 115 - .gitignore | 199 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 96 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 55 +- SECURITY.md | 5 - benchmark/benchmark.js | 47 - benchmark/benchmark.size.js | 94 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 175 - docs/types/test.ts | 86 - examples/index.js | 43 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 100 - lib/main.js | 109 - package.json | 66 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 1022 ---- 44 files changed, 4873 insertions(+), 5370 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 a8a68fb..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/vector/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 f21cc2e..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/vector/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 d88538c..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: '0 0 * * 3' - - # 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 + + ```
@@ -225,7 +216,7 @@ console.log( v.get() ); ## 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]. @@ -288,9 +279,9 @@ Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-vector-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 7418c03..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,47 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* 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 Float32Vector = require( './../lib' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var arr; - var i; - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr = new Float32Vector( 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 cdc4b8c..0000000 --- a/benchmark/benchmark.size.js +++ /dev/null @@ -1,94 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* 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 isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var Float32Vector = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var arr; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr = new Float32Vector( len ); - if ( arr.length !== len ) { - b.fail( 'unexpected length' ); - } - } - 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 len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( format( '%s:size=%d', pkg, len ), f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 6d01049..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/vector/float32" -%% click B href "https://github.com/stdlib-js/ndarray-vector-float32/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-vector-float32/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-vector-float32/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-vector-float32/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-vector-float32/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/vector/float32 -[production-url]: https://github.com/stdlib-js/ndarray-vector-float32/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-vector-float32/tree/deno -[deno-readme]: https://github.com/stdlib-js/ndarray-vector-float32/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/ndarray-vector-float32/tree/umd -[umd-readme]: https://github.com/stdlib-js/ndarray-vector-float32/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/ndarray-vector-float32/tree/esm -[esm-readme]: https://github.com/stdlib-js/ndarray-vector-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 7c5ecb1..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var o=function(a,r){return function(){return r||a((r={exports:{}}).exports,r),r.exports}};var e=o(function(f,t){ -var s=require('@stdlib/ndarray-vector-ctor/dist').factory,c=s("float32");t.exports=c -});var i=e();module.exports=i; -/** @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 a14f526..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) 2025 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* 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-vector-ctor' ).factory;\n\n\n// MAIN //\n\n/**\n* Returns a single-precision floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Float32Vector\n* @type {Function}\n* @param {(NonNegativeInteger|Collection|ArrayBuffer|Iterable)} [arg] - length, typed array, array-like object, buffer, or iterable\n* @param {NonNegativeInteger} [byteOffset=0] - byte offset\n* @param {NonNegativeInteger} [length] - view length\n* @param {Options} [options] - function options\n* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only vector\n* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed vector dimensions\n* @param {string} [options.order='row-major'] - memory layout (either row-major or column-major)\n* @throws {TypeError} first argument must be either a length, typed array, array-like object, buffer, iterable, or options object\n* @throws {TypeError} must provide valid options\n* @returns {ndarray} one-dimensional ndarray\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n*\n* var arr = new Float32Vector();\n* // returns \n*\n* var len = numel( arr );\n* // returns 0\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n*\n* var arr = new Float32Vector( 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n*\n* var arr = new Float32Vector( [ 1.0, 2.0 ] );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf );\n* // returns \n*\n* var len = numel( arr );\n* // returns 8\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf, 16 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 4\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n*\n* var buf = new ArrayBuffer( 64 );\n* var arr = new Float32Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Float32Vector = factory( 'float32' );\n\n\n// EXPORTS //\n\nmodule.exports = Float32Vector;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 vector (i.e., a one-dimensional ndarray).\n*\n* @module @stdlib/ndarray-vector-float32\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var v = new Float32Vector();\n* // returns \n*\n* var len = numel( v );\n* // returns 0\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var v = new Float32Vector( 2 );\n* // returns \n*\n* var len = numel( v );\n* // returns 2\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var v = new Float32Vector( [ 1.0, 2.0 ] );\n* // returns \n*\n* var len = numel( v );\n* // returns 2\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var buf = new ArrayBuffer( 32 );\n* var v = new Float32Vector( buf );\n* // returns \n*\n* var len = numel( v );\n* // returns 8\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var buf = new ArrayBuffer( 32 );\n* var v = new Float32Vector( buf, 16 );\n* // returns \n*\n* var len = numel( v );\n* // returns 4\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var buf = new ArrayBuffer( 64 );\n* var v = new Float32Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( v );\n* // returns 2\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,QAAS,6BAA8B,EAAE,QAiFnDC,EAAgBD,EAAS,SAAU,EAKvCD,EAAO,QAAUE,ICdjB,IAAIC,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "factory", "Float32Vector", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index a92bbdd..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,175 +0,0 @@ - -{{alias}}( [options] ) - Returns a one-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.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A one-dimensional ndarray. - - Examples - -------- - > var arr = {{alias}}() - - - -{{alias}}( length[, options] ) - Returns a one-dimensional single-precision floating-point ndarray having a - specified length. - - Parameters - ---------- - length: integer - 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.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A one-dimensional ndarray. - - Examples - -------- - > var arr = {{alias}}( 5 ) - - > var len = {{alias:@stdlib/ndarray/numel}}( arr ) - 5 - - -{{alias}}( obj[, options] ) - Creates a one-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. - - 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.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A one-dimensional ndarray. - - Examples - -------- - > var v = [ 1.0, 2.0, 3.0 ]; - > var arr = {{alias}}( v ) - - > var len = {{alias:@stdlib/ndarray/numel}}( arr ) - 3 - - -{{alias}}( buffer[, byteOffset[, length]][, options] ) - Returns a one-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. - - length: integer (optional) - View length. If not provided, the view spans from the byteOffset to - the end of the underlying ArrayBuffer. - - 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.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A one-dimensional ndarray. - - Examples - -------- - > var buf = new {{alias:@stdlib/array/buffer}}( 32 ); - > var arr = {{alias}}( buf, 0, 4 ) - - > var len = {{alias:@stdlib/ndarray/numel}}( arr ) - 4 - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index c222353..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,86 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 Float32Vector = require( './index' ); - - -// TESTS // - -// The function returns an ndarray... -{ - new Float32Vector(); // $ExpectType float32ndarray - new Float32Vector( {} ); // $ExpectType float32ndarray - - new Float32Vector( 10 ); // $ExpectType float32ndarray - new Float32Vector( 10, {} ); // $ExpectType float32ndarray - - new Float32Vector( [ 1, 2, 3 ] ); // $ExpectType float32ndarray - new Float32Vector( [ 1, 2, 3 ], {} ); // $ExpectType float32ndarray - - new Float32Vector( new ArrayBuffer( 10 ) ); // $ExpectType float32ndarray - new Float32Vector( new ArrayBuffer( 10 ), {} ); // $ExpectType float32ndarray - - new Float32Vector( new ArrayBuffer( 10 ), 8 ); // $ExpectType float32ndarray - new Float32Vector( new ArrayBuffer( 10 ), 8, {} ); // $ExpectType float32ndarray - - new Float32Vector( new ArrayBuffer( 10 ), 8, 0 ); // $ExpectType float32ndarray - new Float32Vector( new ArrayBuffer( 10 ), 8, 0, {} ); // $ExpectType float32ndarray - - const vector = Float32Vector; - vector(); // $ExpectType float32ndarray - vector( {} ); // $ExpectType float32ndarray - - vector( 10 ); // $ExpectType float32ndarray - vector( 10, {} ); // $ExpectType float32ndarray - - vector( [ 1, 2, 3 ] ); // $ExpectType float32ndarray - vector( [ 1, 2, 3 ], {} ); // $ExpectType float32ndarray - - vector( new ArrayBuffer( 10 ) ); // $ExpectType float32ndarray - vector( new ArrayBuffer( 10 ), {} ); // $ExpectType float32ndarray - - vector( new ArrayBuffer( 10 ), 8 ); // $ExpectType float32ndarray - vector( new ArrayBuffer( 10 ), 8, {} ); // $ExpectType float32ndarray - - vector( new ArrayBuffer( 10 ), 8, 0 ); // $ExpectType float32ndarray - vector( new ArrayBuffer( 10 ), 8, 0, {} ); // $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 Float32Vector( true ); // $ExpectError - new Float32Vector( false ); // $ExpectError - new Float32Vector( null ); // $ExpectError - new Float32Vector( ( x: number ): number => x ); // $ExpectError - - const vector = Float32Vector; - vector( true ); // $ExpectError - vector( false ); // $ExpectError - vector( null ); // $ExpectError - vector( ( 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 Float32Vector( buf, 8, 2, {}, {} ); // $ExpectError - - const vector = Float32Vector; - vector( buf, 8, 2, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 24af996..0000000 --- a/examples/index.js +++ /dev/null @@ -1,43 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 Float32Vector = require( './../lib' ); - -// Create a vector containing random values: -var x = new Float32Vector( discreteUniform( 10, 0, 100 ) ); - -// Compute the sum: -var v = sum( x ); -console.log( v.get() ); - -// 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: -v = sum( y ); -console.log( v.get() ); 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 346c235..fe7ae4c 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 } from '@stdlib/types/ndarray'; import { Collection, AccessorArrayLike } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..3221a3c --- /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-vector-ctor@v0.1.1-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..0e99e27 --- /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) 2025 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* 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-vector-ctor';\n\n\n// MAIN //\n\n/**\n* Returns a single-precision floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Float32Vector\n* @type {Function}\n* @param {(NonNegativeInteger|Collection|ArrayBuffer|Iterable)} [arg] - length, typed array, array-like object, buffer, or iterable\n* @param {NonNegativeInteger} [byteOffset=0] - byte offset\n* @param {NonNegativeInteger} [length] - view length\n* @param {Options} [options] - function options\n* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only vector\n* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed vector dimensions\n* @param {string} [options.order='row-major'] - memory layout (either row-major or column-major)\n* @throws {TypeError} first argument must be either a length, typed array, array-like object, buffer, iterable, or options object\n* @throws {TypeError} must provide valid options\n* @returns {ndarray} one-dimensional ndarray\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector();\n* // returns \n*\n* var len = numel( arr );\n* // returns 0\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector( 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector( [ 1.0, 2.0 ] );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf );\n* // returns \n*\n* var len = numel( arr );\n* // returns 8\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf, 16 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 4\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 64 );\n* var arr = new Float32Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Float32Vector = factory( 'float32' );\n\n\n// EXPORTS //\n\nexport default Float32Vector;\n"],"names":["Float32Vector","factory"],"mappings":";;yGAuGG,IAACA,EAAgBC,EAAS"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 47c8cc7..0000000 --- a/lib/index.js +++ /dev/null @@ -1,100 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 vector (i.e., a one-dimensional ndarray). -* -* @module @stdlib/ndarray-vector-float32 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var v = new Float32Vector(); -* // returns -* -* var len = numel( v ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var v = new Float32Vector( 2 ); -* // returns -* -* var len = numel( v ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var v = new Float32Vector( [ 1.0, 2.0 ] ); -* // returns -* -* var len = numel( v ); -* // returns 2 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var buf = new ArrayBuffer( 32 ); -* var v = new Float32Vector( buf ); -* // returns -* -* var len = numel( v ); -* // returns 8 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var buf = new ArrayBuffer( 32 ); -* var v = new Float32Vector( buf, 16 ); -* // returns -* -* var len = numel( v ); -* // returns 4 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var buf = new ArrayBuffer( 64 ); -* var v = new Float32Vector( buf, 16, 2 ); -* // returns -* -* var len = numel( v ); -* // returns 2 -*/ - -// 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 853738a..0000000 --- a/lib/main.js +++ /dev/null @@ -1,109 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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-vector-ctor' ).factory; - - -// MAIN // - -/** -* Returns a single-precision floating-point vector (i.e., a one-dimensional ndarray). -* -* @name Float32Vector -* @type {Function} -* @param {(NonNegativeInteger|Collection|ArrayBuffer|Iterable)} [arg] - length, typed array, array-like object, buffer, or iterable -* @param {NonNegativeInteger} [byteOffset=0] - byte offset -* @param {NonNegativeInteger} [length] - view length -* @param {Options} [options] - function options -* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only vector -* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed vector dimensions -* @param {string} [options.order='row-major'] - memory layout (either row-major or column-major) -* @throws {TypeError} first argument must be either a length, typed array, array-like object, buffer, iterable, or options object -* @throws {TypeError} must provide valid options -* @returns {ndarray} one-dimensional ndarray -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector(); -* // returns -* -* var len = numel( arr ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector( 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector( [ 1.0, 2.0 ] ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 32 ); -* var arr = new Float32Vector( buf ); -* // returns -* -* var len = numel( arr ); -* // returns 8 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 32 ); -* var arr = new Float32Vector( buf, 16 ); -* // returns -* -* var len = numel( arr ); -* // returns 4 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 64 ); -* var arr = new Float32Vector( buf, 16, 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -*/ -var Float32Vector = factory( 'float32' ); - - -// EXPORTS // - -module.exports = Float32Vector; diff --git a/package.json b/package.json index 515f06f..9eed39e 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.1", "description": "Create a single-precision floating-point vector (i.e., a one-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,45 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/ndarray-vector-ctor": "^0.1.1", - "@stdlib/types": "^0.4.3" - }, - "devDependencies": { - "@stdlib/array-buffer": "^0.2.3", - "@stdlib/array-float32": "^0.2.3", - "@stdlib/array-float64": "^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/buffer-from-array": "^0.2.3", - "@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/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..f8585b0 --- /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 fff6e0e..0000000 --- a/test/test.js +++ /dev/null @@ -1,1022 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 Float64Array = require( '@stdlib/array-float64' ); -var Float32Array = require( '@stdlib/array-float32' ); -var getData = require( '@stdlib/ndarray-data-buffer' ); -var array2buffer = require( '@stdlib/buffer-from-array' ); -var Float32Vector = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof Float32Vector, '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, - function noop() {} - ]; - for ( i = 0; i < 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 Float32Vector( 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, - function noop() {} - ]; - for ( i = 0; i < 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 Float32Vector( value, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (byteoffset)', 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 Float32Vector( value, 0 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (byteoffset, 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 Float32Vector( value, 0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (byteoffset, length)', 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 Float32Vector( value, 0, 1 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (byteoffset, length, 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 Float32Vector( value, 0, 1, {} ); - }; - } -}); - -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 Float32Vector( 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 Float32Vector( new ArrayBuffer( 8 ), value, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid byte offset argument (length)', 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 Float32Vector( new ArrayBuffer( 8 ), value, 1 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid byte offset argument (length, 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 Float32Vector( new ArrayBuffer( 8 ), value, 1, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid length 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 Float32Vector( new ArrayBuffer( 8 ), 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid length 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 Float32Vector( new ArrayBuffer( 8 ), 0, value, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (length)', 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 Float32Vector( 10, 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 Float32Vector( [], 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 Float32Vector( 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 Float32Vector( new ArrayBuffer( 8 ), 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (arraybuffer, byteoffset, length)', 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 Float32Vector( new ArrayBuffer( 8 ), 0, 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 Float32Vector({ - '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 Float32Vector({ - 'mode': 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 Float32Vector({ - 'readonly': value - }); - }; - } -}); - -tape( 'the function returns a one-dimensional ndarray', function test( t ) { - var arr; - - arr = new Float32Vector(); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - - arr = new Float32Vector( {} ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (length)', function test( t ) { - var arr; - - arr = new Float32Vector( 10 ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, 'returns expected value' ); - - arr = new Float32Vector( 10, {} ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (array)', function test( t ) { - var arr; - var out; - - arr = [ 1.0, 2.0, 3.0, 4.0 ]; - - out = new Float32Vector( arr ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - out = new Float32Vector( arr, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (typed array)', function test( t ) { - var arr; - var out; - - arr = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - out = new Float32Vector( arr ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - out = new Float32Vector( arr, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (buffer)', function test( t ) { - var arr; - var out; - var buf; - - arr = [ 1, 2, 3, 4 ]; - buf = array2buffer( arr ); - - out = new Float32Vector( buf ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - out = new Float32Vector( buf, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (arraybuffer)', function test( t ) { - var buf; - var out; - - buf = new ArrayBuffer( 8 ); - - out = new Float32Vector( buf ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 2, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf ) ), true, 'returns expected value' ); - - out = new Float32Vector( buf, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 2, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (arraybuffer, byteoffset)', function test( t ) { - var buf; - var out; - - buf = new ArrayBuffer( 32 ); - - out = new Float32Vector( buf, 8 ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 6, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf, 8 ) ), true, 'returns expected value' ); - - out = new Float32Vector( buf, 8, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 6, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf, 8 ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (arraybuffer, byteoffset, length)', function test( t ) { - var buf; - var out; - - buf = new ArrayBuffer( 32 ); - - out = new Float32Vector( buf, 8, 2 ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 2, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf, 8, 2 ) ), true, 'returns expected value' ); - - out = new Float32Vector( buf, 8, 2, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 2, '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 Float32Vector({ - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Float32Vector({ - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - t.strictEqual( arr.order, 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (length)', function test( t ) { - var arr; - - arr = new Float32Vector( 10, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Float32Vector( 10, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, 'returns expected value' ); - t.strictEqual( arr.order, 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (array)', function test( t ) { - var arr; - - arr = new Float32Vector( [ 1.0, 2.0, 3.0, 4.0 ], { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 4, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Float32Vector( [ 1.0, 2.0, 3.0, 4.0 ], { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 4, 'returns expected value' ); - t.strictEqual( arr.order, 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (arraybuffer)', function test( t ) { - var arr; - - arr = new Float32Vector( new ArrayBuffer( 32 ), { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 8, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Float32Vector( new ArrayBuffer( 32 ), { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 8, 'returns expected value' ); - t.strictEqual( arr.order, 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (arraybuffer, byteoffset)', function test( t ) { - var arr; - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 6, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 6, 'returns expected value' ); - t.strictEqual( arr.order, 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (arraybuffer, byteoffset, length)', function test( t ) { - var arr; - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, 2, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 2, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, 2, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 2, 'returns expected value' ); - t.strictEqual( arr.order, 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning read-only ndarrays', function test( t ) { - var arr; - - arr = new Float32Vector({ - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning read-only ndarrays (length)', function test( t ) { - var arr; - - arr = new Float32Vector( 10, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, '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 Float32Vector( [ 1.0, 2.0, 3.0, 4.0 ], { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 4, '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 Float32Vector( new ArrayBuffer( 32 ), { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 8, '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 Float32Vector( new ArrayBuffer( 32 ), 8, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 6, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning read-only ndarrays (arraybuffer, byteoffset, length)', function test( t ) { - var arr; - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, 2, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 2, '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 Float32Vector({ - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning writable ndarrays (length)', function test( t ) { - var arr; - - arr = new Float32Vector( 10, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, '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 Float32Vector( [ 1.0, 2.0, 3.0, 4.0 ], { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 4, '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 Float32Vector( new ArrayBuffer( 32 ), { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 8, '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 Float32Vector( new ArrayBuffer( 32 ), 8, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 6, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning writable ndarrays (arraybuffer, byteoffset, length)', function test( t ) { - var arr; - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, 2, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 2, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); From c19702832745a06a408cb11efdf05a602781fea4 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 27 Apr 2026 03:54:55 +0000 Subject: [PATCH 31/42] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 176d911..515f06f 100644 --- a/package.json +++ b/package.json @@ -54,7 +54,7 @@ "@stdlib/ndarray-data-buffer": "^0.2.3", "@stdlib/ndarray-map": "^0.1.1", "@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 26a60447999d523328244f50c88e8f92b7bd4549 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 27 Apr 2026 04:15:24 +0000 Subject: [PATCH 32/42] Remove files --- index.d.ts | 377 ---- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5224 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 fe7ae4c..0000000 --- a/index.d.ts +++ /dev/null @@ -1,377 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 } from '@stdlib/types/ndarray'; -import { Collection, AccessorArrayLike } 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; - - /** - * Boolean indicating whether an array should be read-only (default: false). - */ - readonly?: boolean; -} - -/** -* Interface defining a typed vector constructor which is both "newable" and "callable". -*/ -interface Float32Vector { - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector(); - * // returns - * - * var len = numel( arr ); - * // returns 0 - */ - new ( options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param length - vector length - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector( 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( length: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param obj - array-like object or iterable from which to generate a vector - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector( [ 1.0, 2.0 ] ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( obj: Collection | AccessorArrayLike | Iterable, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Vector( buf ); - * // returns - * - * var len = numel( arr ); - * // returns 8 - */ - new ( buffer: ArrayBuffer, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param byteOffset - integer byte offset specifying the location of the first vector element - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Vector( buf, 8 ); - * // returns - * - * var len = numel( arr ); - * // returns 6 - */ - new ( buffer: ArrayBuffer, byteOffset: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param byteOffset - integer byte offset specifying the location of the first vector element - * @param length - view length; if not provided, the view spans from the byteOffset to the end of the underlying ArrayBuffer - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Vector( buf, 8, 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( buffer: ArrayBuffer, byteOffset: number, length: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector(); - * // returns - * - * var len = numel( arr ); - * // returns 0 - */ - ( options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param length - vector length - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector( 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( length: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param obj - array-like object or iterable from which to generate a vector - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector( [ 1.0, 2.0 ] ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( obj: Collection | AccessorArrayLike | Iterable, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Vector( buf ); - * // returns - * - * var len = numel( arr ); - * // returns 8 - */ - ( buffer: ArrayBuffer, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param byteOffset - integer byte offset specifying the location of the first vector element - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Vector( buf, 8 ); - * // returns - * - * var len = numel( arr ); - * // returns 6 - */ - ( buffer: ArrayBuffer, byteOffset: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param byteOffset - integer byte offset specifying the location of the first vector element - * @param length - view length; if not provided, the view spans from the byteOffset to the end of the underlying ArrayBuffer - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Vector( buf, 8, 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( buffer: ArrayBuffer, byteOffset: number, length: number, options?: Options ): float32ndarray; -} - -/** -* Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). -* -* @param arg - length, typed array, array-like object, buffer, or iterable -* @param byteOffset - integer byte offset specifying the location of the first vector element (default: 0) -* @param length - view length; if not provided, the view spans from the byteOffset to the end of the underlying ArrayBuffer -* @param options - function options -* @param options.readonly - boolean indicating whether to return a read-only vector -* @param options.mode - specifies how to handle indices which exceed vector dimensions -* @param options.order - memory layout (either row-major or column-major) -* @returns one-dimensional ndarray -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector(); -* // returns -* -* var len = numel( arr ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector( 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector( [ 1.0, 2.0 ] ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 32 ); -* var arr = new Float32Vector( buf, 8, 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -*/ -declare var ctor: Float32Vector; - - -// EXPORTS // - -export = ctor; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 3221a3c..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-vector-ctor@v0.1.1-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 0e99e27..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) 2025 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* 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-vector-ctor';\n\n\n// MAIN //\n\n/**\n* Returns a single-precision floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Float32Vector\n* @type {Function}\n* @param {(NonNegativeInteger|Collection|ArrayBuffer|Iterable)} [arg] - length, typed array, array-like object, buffer, or iterable\n* @param {NonNegativeInteger} [byteOffset=0] - byte offset\n* @param {NonNegativeInteger} [length] - view length\n* @param {Options} [options] - function options\n* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only vector\n* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed vector dimensions\n* @param {string} [options.order='row-major'] - memory layout (either row-major or column-major)\n* @throws {TypeError} first argument must be either a length, typed array, array-like object, buffer, iterable, or options object\n* @throws {TypeError} must provide valid options\n* @returns {ndarray} one-dimensional ndarray\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector();\n* // returns \n*\n* var len = numel( arr );\n* // returns 0\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector( 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector( [ 1.0, 2.0 ] );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf );\n* // returns \n*\n* var len = numel( arr );\n* // returns 8\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf, 16 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 4\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 64 );\n* var arr = new Float32Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Float32Vector = factory( 'float32' );\n\n\n// EXPORTS //\n\nexport default Float32Vector;\n"],"names":["Float32Vector","factory"],"mappings":";;yGAuGG,IAACA,EAAgBC,EAAS"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index f8585b0..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 5d371c6a7c2a68eb5a2a02b76f1af76ce886d931 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 27 Apr 2026 04:16:24 +0000 Subject: [PATCH 33/42] 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 | 31 - CHANGELOG.md | 97 - 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 | 94 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 175 - docs/types/test.ts | 86 - examples/index.js | 43 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 100 - lib/main.js | 109 - package.json | 66 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 1022 ---- 44 files changed, 4877 insertions(+), 5380 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 a8a68fb..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/vector/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 f21cc2e..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/vector/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 d88538c..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: '0 0 * * 3' - - # 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 + + ```
@@ -235,7 +226,7 @@ console.log( v.get() ); ## 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]. @@ -298,19 +289,19 @@ Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-vector-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/vector/float64]: https://github.com/stdlib-js/ndarray-vector-float64 +[@stdlib/ndarray/vector/float64]: https://github.com/stdlib-js/ndarray-vector-float64/tree/esm -[@stdlib/ndarray/vector/complex128]: https://github.com/stdlib-js/ndarray-vector-complex128 +[@stdlib/ndarray/vector/complex128]: https://github.com/stdlib-js/ndarray-vector-complex128/tree/esm -[@stdlib/ndarray/vector/complex64]: https://github.com/stdlib-js/ndarray-vector-complex64 +[@stdlib/ndarray/vector/complex64]: https://github.com/stdlib-js/ndarray-vector-complex64/tree/esm -[@stdlib/ndarray/vector/ctor]: https://github.com/stdlib-js/ndarray-vector-ctor +[@stdlib/ndarray/vector/ctor]: https://github.com/stdlib-js/ndarray-vector-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 7418c03..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,47 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* 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 Float32Vector = require( './../lib' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var arr; - var i; - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr = new Float32Vector( 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 cdc4b8c..0000000 --- a/benchmark/benchmark.size.js +++ /dev/null @@ -1,94 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* 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 isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var Float32Vector = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var arr; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr = new Float32Vector( len ); - if ( arr.length !== len ) { - b.fail( 'unexpected length' ); - } - } - 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 len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( format( '%s:size=%d', pkg, len ), f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 6d01049..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/vector/float32" -%% click B href "https://github.com/stdlib-js/ndarray-vector-float32/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-vector-float32/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-vector-float32/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-vector-float32/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-vector-float32/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/vector/float32 -[production-url]: https://github.com/stdlib-js/ndarray-vector-float32/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-vector-float32/tree/deno -[deno-readme]: https://github.com/stdlib-js/ndarray-vector-float32/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/ndarray-vector-float32/tree/umd -[umd-readme]: https://github.com/stdlib-js/ndarray-vector-float32/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/ndarray-vector-float32/tree/esm -[esm-readme]: https://github.com/stdlib-js/ndarray-vector-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 7c5ecb1..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var o=function(a,r){return function(){return r||a((r={exports:{}}).exports,r),r.exports}};var e=o(function(f,t){ -var s=require('@stdlib/ndarray-vector-ctor/dist').factory,c=s("float32");t.exports=c -});var i=e();module.exports=i; -/** @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 a14f526..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) 2025 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* 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-vector-ctor' ).factory;\n\n\n// MAIN //\n\n/**\n* Returns a single-precision floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Float32Vector\n* @type {Function}\n* @param {(NonNegativeInteger|Collection|ArrayBuffer|Iterable)} [arg] - length, typed array, array-like object, buffer, or iterable\n* @param {NonNegativeInteger} [byteOffset=0] - byte offset\n* @param {NonNegativeInteger} [length] - view length\n* @param {Options} [options] - function options\n* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only vector\n* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed vector dimensions\n* @param {string} [options.order='row-major'] - memory layout (either row-major or column-major)\n* @throws {TypeError} first argument must be either a length, typed array, array-like object, buffer, iterable, or options object\n* @throws {TypeError} must provide valid options\n* @returns {ndarray} one-dimensional ndarray\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n*\n* var arr = new Float32Vector();\n* // returns \n*\n* var len = numel( arr );\n* // returns 0\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n*\n* var arr = new Float32Vector( 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n*\n* var arr = new Float32Vector( [ 1.0, 2.0 ] );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf );\n* // returns \n*\n* var len = numel( arr );\n* // returns 8\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf, 16 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 4\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n*\n* var buf = new ArrayBuffer( 64 );\n* var arr = new Float32Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Float32Vector = factory( 'float32' );\n\n\n// EXPORTS //\n\nmodule.exports = Float32Vector;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 vector (i.e., a one-dimensional ndarray).\n*\n* @module @stdlib/ndarray-vector-float32\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var v = new Float32Vector();\n* // returns \n*\n* var len = numel( v );\n* // returns 0\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var v = new Float32Vector( 2 );\n* // returns \n*\n* var len = numel( v );\n* // returns 2\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var v = new Float32Vector( [ 1.0, 2.0 ] );\n* // returns \n*\n* var len = numel( v );\n* // returns 2\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var buf = new ArrayBuffer( 32 );\n* var v = new Float32Vector( buf );\n* // returns \n*\n* var len = numel( v );\n* // returns 8\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var buf = new ArrayBuffer( 32 );\n* var v = new Float32Vector( buf, 16 );\n* // returns \n*\n* var len = numel( v );\n* // returns 4\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var buf = new ArrayBuffer( 64 );\n* var v = new Float32Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( v );\n* // returns 2\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,QAAS,6BAA8B,EAAE,QAiFnDC,EAAgBD,EAAS,SAAU,EAKvCD,EAAO,QAAUE,ICdjB,IAAIC,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "factory", "Float32Vector", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index a92bbdd..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,175 +0,0 @@ - -{{alias}}( [options] ) - Returns a one-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.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A one-dimensional ndarray. - - Examples - -------- - > var arr = {{alias}}() - - - -{{alias}}( length[, options] ) - Returns a one-dimensional single-precision floating-point ndarray having a - specified length. - - Parameters - ---------- - length: integer - 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.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A one-dimensional ndarray. - - Examples - -------- - > var arr = {{alias}}( 5 ) - - > var len = {{alias:@stdlib/ndarray/numel}}( arr ) - 5 - - -{{alias}}( obj[, options] ) - Creates a one-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. - - 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.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A one-dimensional ndarray. - - Examples - -------- - > var v = [ 1.0, 2.0, 3.0 ]; - > var arr = {{alias}}( v ) - - > var len = {{alias:@stdlib/ndarray/numel}}( arr ) - 3 - - -{{alias}}( buffer[, byteOffset[, length]][, options] ) - Returns a one-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. - - length: integer (optional) - View length. If not provided, the view spans from the byteOffset to - the end of the underlying ArrayBuffer. - - 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.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A one-dimensional ndarray. - - Examples - -------- - > var buf = new {{alias:@stdlib/array/buffer}}( 32 ); - > var arr = {{alias}}( buf, 0, 4 ) - - > var len = {{alias:@stdlib/ndarray/numel}}( arr ) - 4 - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index c222353..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,86 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 Float32Vector = require( './index' ); - - -// TESTS // - -// The function returns an ndarray... -{ - new Float32Vector(); // $ExpectType float32ndarray - new Float32Vector( {} ); // $ExpectType float32ndarray - - new Float32Vector( 10 ); // $ExpectType float32ndarray - new Float32Vector( 10, {} ); // $ExpectType float32ndarray - - new Float32Vector( [ 1, 2, 3 ] ); // $ExpectType float32ndarray - new Float32Vector( [ 1, 2, 3 ], {} ); // $ExpectType float32ndarray - - new Float32Vector( new ArrayBuffer( 10 ) ); // $ExpectType float32ndarray - new Float32Vector( new ArrayBuffer( 10 ), {} ); // $ExpectType float32ndarray - - new Float32Vector( new ArrayBuffer( 10 ), 8 ); // $ExpectType float32ndarray - new Float32Vector( new ArrayBuffer( 10 ), 8, {} ); // $ExpectType float32ndarray - - new Float32Vector( new ArrayBuffer( 10 ), 8, 0 ); // $ExpectType float32ndarray - new Float32Vector( new ArrayBuffer( 10 ), 8, 0, {} ); // $ExpectType float32ndarray - - const vector = Float32Vector; - vector(); // $ExpectType float32ndarray - vector( {} ); // $ExpectType float32ndarray - - vector( 10 ); // $ExpectType float32ndarray - vector( 10, {} ); // $ExpectType float32ndarray - - vector( [ 1, 2, 3 ] ); // $ExpectType float32ndarray - vector( [ 1, 2, 3 ], {} ); // $ExpectType float32ndarray - - vector( new ArrayBuffer( 10 ) ); // $ExpectType float32ndarray - vector( new ArrayBuffer( 10 ), {} ); // $ExpectType float32ndarray - - vector( new ArrayBuffer( 10 ), 8 ); // $ExpectType float32ndarray - vector( new ArrayBuffer( 10 ), 8, {} ); // $ExpectType float32ndarray - - vector( new ArrayBuffer( 10 ), 8, 0 ); // $ExpectType float32ndarray - vector( new ArrayBuffer( 10 ), 8, 0, {} ); // $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 Float32Vector( true ); // $ExpectError - new Float32Vector( false ); // $ExpectError - new Float32Vector( null ); // $ExpectError - new Float32Vector( ( x: number ): number => x ); // $ExpectError - - const vector = Float32Vector; - vector( true ); // $ExpectError - vector( false ); // $ExpectError - vector( null ); // $ExpectError - vector( ( 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 Float32Vector( buf, 8, 2, {}, {} ); // $ExpectError - - const vector = Float32Vector; - vector( buf, 8, 2, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 24af996..0000000 --- a/examples/index.js +++ /dev/null @@ -1,43 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 Float32Vector = require( './../lib' ); - -// Create a vector containing random values: -var x = new Float32Vector( discreteUniform( 10, 0, 100 ) ); - -// Compute the sum: -var v = sum( x ); -console.log( v.get() ); - -// 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: -v = sum( y ); -console.log( v.get() ); 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 346c235..fe7ae4c 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 } from '@stdlib/types/ndarray'; import { Collection, AccessorArrayLike } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..3221a3c --- /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-vector-ctor@v0.1.1-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..0e99e27 --- /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) 2025 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* 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-vector-ctor';\n\n\n// MAIN //\n\n/**\n* Returns a single-precision floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Float32Vector\n* @type {Function}\n* @param {(NonNegativeInteger|Collection|ArrayBuffer|Iterable)} [arg] - length, typed array, array-like object, buffer, or iterable\n* @param {NonNegativeInteger} [byteOffset=0] - byte offset\n* @param {NonNegativeInteger} [length] - view length\n* @param {Options} [options] - function options\n* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only vector\n* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed vector dimensions\n* @param {string} [options.order='row-major'] - memory layout (either row-major or column-major)\n* @throws {TypeError} first argument must be either a length, typed array, array-like object, buffer, iterable, or options object\n* @throws {TypeError} must provide valid options\n* @returns {ndarray} one-dimensional ndarray\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector();\n* // returns \n*\n* var len = numel( arr );\n* // returns 0\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector( 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector( [ 1.0, 2.0 ] );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf );\n* // returns \n*\n* var len = numel( arr );\n* // returns 8\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf, 16 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 4\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 64 );\n* var arr = new Float32Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Float32Vector = factory( 'float32' );\n\n\n// EXPORTS //\n\nexport default Float32Vector;\n"],"names":["Float32Vector","factory"],"mappings":";;yGAuGG,IAACA,EAAgBC,EAAS"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 47c8cc7..0000000 --- a/lib/index.js +++ /dev/null @@ -1,100 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 vector (i.e., a one-dimensional ndarray). -* -* @module @stdlib/ndarray-vector-float32 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var v = new Float32Vector(); -* // returns -* -* var len = numel( v ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var v = new Float32Vector( 2 ); -* // returns -* -* var len = numel( v ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var v = new Float32Vector( [ 1.0, 2.0 ] ); -* // returns -* -* var len = numel( v ); -* // returns 2 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var buf = new ArrayBuffer( 32 ); -* var v = new Float32Vector( buf ); -* // returns -* -* var len = numel( v ); -* // returns 8 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var buf = new ArrayBuffer( 32 ); -* var v = new Float32Vector( buf, 16 ); -* // returns -* -* var len = numel( v ); -* // returns 4 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var buf = new ArrayBuffer( 64 ); -* var v = new Float32Vector( buf, 16, 2 ); -* // returns -* -* var len = numel( v ); -* // returns 2 -*/ - -// 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 853738a..0000000 --- a/lib/main.js +++ /dev/null @@ -1,109 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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-vector-ctor' ).factory; - - -// MAIN // - -/** -* Returns a single-precision floating-point vector (i.e., a one-dimensional ndarray). -* -* @name Float32Vector -* @type {Function} -* @param {(NonNegativeInteger|Collection|ArrayBuffer|Iterable)} [arg] - length, typed array, array-like object, buffer, or iterable -* @param {NonNegativeInteger} [byteOffset=0] - byte offset -* @param {NonNegativeInteger} [length] - view length -* @param {Options} [options] - function options -* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only vector -* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed vector dimensions -* @param {string} [options.order='row-major'] - memory layout (either row-major or column-major) -* @throws {TypeError} first argument must be either a length, typed array, array-like object, buffer, iterable, or options object -* @throws {TypeError} must provide valid options -* @returns {ndarray} one-dimensional ndarray -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector(); -* // returns -* -* var len = numel( arr ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector( 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector( [ 1.0, 2.0 ] ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 32 ); -* var arr = new Float32Vector( buf ); -* // returns -* -* var len = numel( arr ); -* // returns 8 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 32 ); -* var arr = new Float32Vector( buf, 16 ); -* // returns -* -* var len = numel( arr ); -* // returns 4 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 64 ); -* var arr = new Float32Vector( buf, 16, 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -*/ -var Float32Vector = factory( 'float32' ); - - -// EXPORTS // - -module.exports = Float32Vector; diff --git a/package.json b/package.json index 515f06f..9eed39e 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.1", "description": "Create a single-precision floating-point vector (i.e., a one-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,45 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/ndarray-vector-ctor": "^0.1.1", - "@stdlib/types": "^0.4.3" - }, - "devDependencies": { - "@stdlib/array-buffer": "^0.2.3", - "@stdlib/array-float32": "^0.2.3", - "@stdlib/array-float64": "^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/buffer-from-array": "^0.2.3", - "@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/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..f8585b0 --- /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 fff6e0e..0000000 --- a/test/test.js +++ /dev/null @@ -1,1022 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 Float64Array = require( '@stdlib/array-float64' ); -var Float32Array = require( '@stdlib/array-float32' ); -var getData = require( '@stdlib/ndarray-data-buffer' ); -var array2buffer = require( '@stdlib/buffer-from-array' ); -var Float32Vector = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof Float32Vector, '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, - function noop() {} - ]; - for ( i = 0; i < 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 Float32Vector( 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, - function noop() {} - ]; - for ( i = 0; i < 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 Float32Vector( value, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (byteoffset)', 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 Float32Vector( value, 0 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (byteoffset, 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 Float32Vector( value, 0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (byteoffset, length)', 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 Float32Vector( value, 0, 1 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (byteoffset, length, 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 Float32Vector( value, 0, 1, {} ); - }; - } -}); - -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 Float32Vector( 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 Float32Vector( new ArrayBuffer( 8 ), value, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid byte offset argument (length)', 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 Float32Vector( new ArrayBuffer( 8 ), value, 1 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid byte offset argument (length, 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 Float32Vector( new ArrayBuffer( 8 ), value, 1, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid length 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 Float32Vector( new ArrayBuffer( 8 ), 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid length 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 Float32Vector( new ArrayBuffer( 8 ), 0, value, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (length)', 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 Float32Vector( 10, 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 Float32Vector( [], 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 Float32Vector( 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 Float32Vector( new ArrayBuffer( 8 ), 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (arraybuffer, byteoffset, length)', 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 Float32Vector( new ArrayBuffer( 8 ), 0, 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 Float32Vector({ - '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 Float32Vector({ - 'mode': 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 Float32Vector({ - 'readonly': value - }); - }; - } -}); - -tape( 'the function returns a one-dimensional ndarray', function test( t ) { - var arr; - - arr = new Float32Vector(); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - - arr = new Float32Vector( {} ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (length)', function test( t ) { - var arr; - - arr = new Float32Vector( 10 ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, 'returns expected value' ); - - arr = new Float32Vector( 10, {} ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (array)', function test( t ) { - var arr; - var out; - - arr = [ 1.0, 2.0, 3.0, 4.0 ]; - - out = new Float32Vector( arr ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - out = new Float32Vector( arr, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (typed array)', function test( t ) { - var arr; - var out; - - arr = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - out = new Float32Vector( arr ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - out = new Float32Vector( arr, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (buffer)', function test( t ) { - var arr; - var out; - var buf; - - arr = [ 1, 2, 3, 4 ]; - buf = array2buffer( arr ); - - out = new Float32Vector( buf ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - out = new Float32Vector( buf, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (arraybuffer)', function test( t ) { - var buf; - var out; - - buf = new ArrayBuffer( 8 ); - - out = new Float32Vector( buf ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 2, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf ) ), true, 'returns expected value' ); - - out = new Float32Vector( buf, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 2, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (arraybuffer, byteoffset)', function test( t ) { - var buf; - var out; - - buf = new ArrayBuffer( 32 ); - - out = new Float32Vector( buf, 8 ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 6, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf, 8 ) ), true, 'returns expected value' ); - - out = new Float32Vector( buf, 8, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 6, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf, 8 ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (arraybuffer, byteoffset, length)', function test( t ) { - var buf; - var out; - - buf = new ArrayBuffer( 32 ); - - out = new Float32Vector( buf, 8, 2 ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 2, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf, 8, 2 ) ), true, 'returns expected value' ); - - out = new Float32Vector( buf, 8, 2, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 2, '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 Float32Vector({ - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Float32Vector({ - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - t.strictEqual( arr.order, 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (length)', function test( t ) { - var arr; - - arr = new Float32Vector( 10, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Float32Vector( 10, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, 'returns expected value' ); - t.strictEqual( arr.order, 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (array)', function test( t ) { - var arr; - - arr = new Float32Vector( [ 1.0, 2.0, 3.0, 4.0 ], { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 4, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Float32Vector( [ 1.0, 2.0, 3.0, 4.0 ], { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 4, 'returns expected value' ); - t.strictEqual( arr.order, 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (arraybuffer)', function test( t ) { - var arr; - - arr = new Float32Vector( new ArrayBuffer( 32 ), { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 8, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Float32Vector( new ArrayBuffer( 32 ), { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 8, 'returns expected value' ); - t.strictEqual( arr.order, 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (arraybuffer, byteoffset)', function test( t ) { - var arr; - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 6, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 6, 'returns expected value' ); - t.strictEqual( arr.order, 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (arraybuffer, byteoffset, length)', function test( t ) { - var arr; - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, 2, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 2, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, 2, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 2, 'returns expected value' ); - t.strictEqual( arr.order, 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning read-only ndarrays', function test( t ) { - var arr; - - arr = new Float32Vector({ - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning read-only ndarrays (length)', function test( t ) { - var arr; - - arr = new Float32Vector( 10, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, '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 Float32Vector( [ 1.0, 2.0, 3.0, 4.0 ], { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 4, '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 Float32Vector( new ArrayBuffer( 32 ), { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 8, '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 Float32Vector( new ArrayBuffer( 32 ), 8, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 6, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning read-only ndarrays (arraybuffer, byteoffset, length)', function test( t ) { - var arr; - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, 2, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 2, '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 Float32Vector({ - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning writable ndarrays (length)', function test( t ) { - var arr; - - arr = new Float32Vector( 10, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, '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 Float32Vector( [ 1.0, 2.0, 3.0, 4.0 ], { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 4, '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 Float32Vector( new ArrayBuffer( 32 ), { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 8, '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 Float32Vector( new ArrayBuffer( 32 ), 8, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 6, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning writable ndarrays (arraybuffer, byteoffset, length)', function test( t ) { - var arr; - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, 2, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 2, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); From 4079526b6f8994a8ca718f15f68fad853778722a Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 17 May 2026 03:49:56 +0000 Subject: [PATCH 34/42] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 176d911..515f06f 100644 --- a/package.json +++ b/package.json @@ -54,7 +54,7 @@ "@stdlib/ndarray-data-buffer": "^0.2.3", "@stdlib/ndarray-map": "^0.1.1", "@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 1c2d317acfe316dc1fd7d9db55cb4f090ee0874c Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 17 May 2026 03:57:39 +0000 Subject: [PATCH 35/42] Remove files --- index.d.ts | 377 ---- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5224 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 fe7ae4c..0000000 --- a/index.d.ts +++ /dev/null @@ -1,377 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 } from '@stdlib/types/ndarray'; -import { Collection, AccessorArrayLike } 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; - - /** - * Boolean indicating whether an array should be read-only (default: false). - */ - readonly?: boolean; -} - -/** -* Interface defining a typed vector constructor which is both "newable" and "callable". -*/ -interface Float32Vector { - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector(); - * // returns - * - * var len = numel( arr ); - * // returns 0 - */ - new ( options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param length - vector length - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector( 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( length: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param obj - array-like object or iterable from which to generate a vector - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector( [ 1.0, 2.0 ] ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( obj: Collection | AccessorArrayLike | Iterable, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Vector( buf ); - * // returns - * - * var len = numel( arr ); - * // returns 8 - */ - new ( buffer: ArrayBuffer, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param byteOffset - integer byte offset specifying the location of the first vector element - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Vector( buf, 8 ); - * // returns - * - * var len = numel( arr ); - * // returns 6 - */ - new ( buffer: ArrayBuffer, byteOffset: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param byteOffset - integer byte offset specifying the location of the first vector element - * @param length - view length; if not provided, the view spans from the byteOffset to the end of the underlying ArrayBuffer - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Vector( buf, 8, 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( buffer: ArrayBuffer, byteOffset: number, length: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector(); - * // returns - * - * var len = numel( arr ); - * // returns 0 - */ - ( options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param length - vector length - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector( 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( length: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param obj - array-like object or iterable from which to generate a vector - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector( [ 1.0, 2.0 ] ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( obj: Collection | AccessorArrayLike | Iterable, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Vector( buf ); - * // returns - * - * var len = numel( arr ); - * // returns 8 - */ - ( buffer: ArrayBuffer, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param byteOffset - integer byte offset specifying the location of the first vector element - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Vector( buf, 8 ); - * // returns - * - * var len = numel( arr ); - * // returns 6 - */ - ( buffer: ArrayBuffer, byteOffset: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param byteOffset - integer byte offset specifying the location of the first vector element - * @param length - view length; if not provided, the view spans from the byteOffset to the end of the underlying ArrayBuffer - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Vector( buf, 8, 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( buffer: ArrayBuffer, byteOffset: number, length: number, options?: Options ): float32ndarray; -} - -/** -* Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). -* -* @param arg - length, typed array, array-like object, buffer, or iterable -* @param byteOffset - integer byte offset specifying the location of the first vector element (default: 0) -* @param length - view length; if not provided, the view spans from the byteOffset to the end of the underlying ArrayBuffer -* @param options - function options -* @param options.readonly - boolean indicating whether to return a read-only vector -* @param options.mode - specifies how to handle indices which exceed vector dimensions -* @param options.order - memory layout (either row-major or column-major) -* @returns one-dimensional ndarray -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector(); -* // returns -* -* var len = numel( arr ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector( 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector( [ 1.0, 2.0 ] ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 32 ); -* var arr = new Float32Vector( buf, 8, 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -*/ -declare var ctor: Float32Vector; - - -// EXPORTS // - -export = ctor; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 3221a3c..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-vector-ctor@v0.1.1-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 0e99e27..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) 2025 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* 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-vector-ctor';\n\n\n// MAIN //\n\n/**\n* Returns a single-precision floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Float32Vector\n* @type {Function}\n* @param {(NonNegativeInteger|Collection|ArrayBuffer|Iterable)} [arg] - length, typed array, array-like object, buffer, or iterable\n* @param {NonNegativeInteger} [byteOffset=0] - byte offset\n* @param {NonNegativeInteger} [length] - view length\n* @param {Options} [options] - function options\n* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only vector\n* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed vector dimensions\n* @param {string} [options.order='row-major'] - memory layout (either row-major or column-major)\n* @throws {TypeError} first argument must be either a length, typed array, array-like object, buffer, iterable, or options object\n* @throws {TypeError} must provide valid options\n* @returns {ndarray} one-dimensional ndarray\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector();\n* // returns \n*\n* var len = numel( arr );\n* // returns 0\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector( 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector( [ 1.0, 2.0 ] );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf );\n* // returns \n*\n* var len = numel( arr );\n* // returns 8\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf, 16 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 4\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 64 );\n* var arr = new Float32Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Float32Vector = factory( 'float32' );\n\n\n// EXPORTS //\n\nexport default Float32Vector;\n"],"names":["Float32Vector","factory"],"mappings":";;yGAuGG,IAACA,EAAgBC,EAAS"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index f8585b0..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 0b93fcbea3cab869d70b0eb05b6d666fe8b2037f Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 17 May 2026 03:58:09 +0000 Subject: [PATCH 36/42] Auto-generated commit --- .editorconfig | 189 - .eslintrc.js | 1 - .gitattributes | 68 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 821 --- .github/workflows/publish.yml | 261 - .github/workflows/test.yml | 101 - .github/workflows/test_bundles.yml | 213 - .github/workflows/test_coverage.yml | 142 - .github/workflows/test_install.yml | 94 - .github/workflows/test_published_package.yml | 115 - .gitignore | 204 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 97 - 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 | 94 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 175 - docs/types/test.ts | 86 - examples/index.js | 43 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 100 - lib/main.js | 109 - package.json | 66 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 1022 ---- 45 files changed, 4877 insertions(+), 5381 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 e0e893e..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2026-05-17T03:40:49.488Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index a8a68fb..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/vector/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 f21cc2e..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/vector/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 d88538c..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: '0 0 * * 3' - - # 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 + + ```
@@ -235,7 +226,7 @@ console.log( v.get() ); ## 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]. @@ -298,19 +289,19 @@ Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-vector-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/vector/float64]: https://github.com/stdlib-js/ndarray-vector-float64 +[@stdlib/ndarray/vector/float64]: https://github.com/stdlib-js/ndarray-vector-float64/tree/esm -[@stdlib/ndarray/vector/complex128]: https://github.com/stdlib-js/ndarray-vector-complex128 +[@stdlib/ndarray/vector/complex128]: https://github.com/stdlib-js/ndarray-vector-complex128/tree/esm -[@stdlib/ndarray/vector/complex64]: https://github.com/stdlib-js/ndarray-vector-complex64 +[@stdlib/ndarray/vector/complex64]: https://github.com/stdlib-js/ndarray-vector-complex64/tree/esm -[@stdlib/ndarray/vector/ctor]: https://github.com/stdlib-js/ndarray-vector-ctor +[@stdlib/ndarray/vector/ctor]: https://github.com/stdlib-js/ndarray-vector-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 7418c03..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,47 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* 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 Float32Vector = require( './../lib' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var arr; - var i; - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr = new Float32Vector( 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 cdc4b8c..0000000 --- a/benchmark/benchmark.size.js +++ /dev/null @@ -1,94 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* 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 isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var Float32Vector = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var arr; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr = new Float32Vector( len ); - if ( arr.length !== len ) { - b.fail( 'unexpected length' ); - } - } - 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 len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( format( '%s:size=%d', pkg, len ), f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 6d01049..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/vector/float32" -%% click B href "https://github.com/stdlib-js/ndarray-vector-float32/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-vector-float32/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-vector-float32/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-vector-float32/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-vector-float32/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/vector/float32 -[production-url]: https://github.com/stdlib-js/ndarray-vector-float32/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-vector-float32/tree/deno -[deno-readme]: https://github.com/stdlib-js/ndarray-vector-float32/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/ndarray-vector-float32/tree/umd -[umd-readme]: https://github.com/stdlib-js/ndarray-vector-float32/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/ndarray-vector-float32/tree/esm -[esm-readme]: https://github.com/stdlib-js/ndarray-vector-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 7c5ecb1..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var o=function(a,r){return function(){return r||a((r={exports:{}}).exports,r),r.exports}};var e=o(function(f,t){ -var s=require('@stdlib/ndarray-vector-ctor/dist').factory,c=s("float32");t.exports=c -});var i=e();module.exports=i; -/** @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 a14f526..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) 2025 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* 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-vector-ctor' ).factory;\n\n\n// MAIN //\n\n/**\n* Returns a single-precision floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Float32Vector\n* @type {Function}\n* @param {(NonNegativeInteger|Collection|ArrayBuffer|Iterable)} [arg] - length, typed array, array-like object, buffer, or iterable\n* @param {NonNegativeInteger} [byteOffset=0] - byte offset\n* @param {NonNegativeInteger} [length] - view length\n* @param {Options} [options] - function options\n* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only vector\n* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed vector dimensions\n* @param {string} [options.order='row-major'] - memory layout (either row-major or column-major)\n* @throws {TypeError} first argument must be either a length, typed array, array-like object, buffer, iterable, or options object\n* @throws {TypeError} must provide valid options\n* @returns {ndarray} one-dimensional ndarray\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n*\n* var arr = new Float32Vector();\n* // returns \n*\n* var len = numel( arr );\n* // returns 0\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n*\n* var arr = new Float32Vector( 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n*\n* var arr = new Float32Vector( [ 1.0, 2.0 ] );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf );\n* // returns \n*\n* var len = numel( arr );\n* // returns 8\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf, 16 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 4\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n*\n* var buf = new ArrayBuffer( 64 );\n* var arr = new Float32Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Float32Vector = factory( 'float32' );\n\n\n// EXPORTS //\n\nmodule.exports = Float32Vector;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 vector (i.e., a one-dimensional ndarray).\n*\n* @module @stdlib/ndarray-vector-float32\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var v = new Float32Vector();\n* // returns \n*\n* var len = numel( v );\n* // returns 0\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var v = new Float32Vector( 2 );\n* // returns \n*\n* var len = numel( v );\n* // returns 2\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var v = new Float32Vector( [ 1.0, 2.0 ] );\n* // returns \n*\n* var len = numel( v );\n* // returns 2\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var buf = new ArrayBuffer( 32 );\n* var v = new Float32Vector( buf );\n* // returns \n*\n* var len = numel( v );\n* // returns 8\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var buf = new ArrayBuffer( 32 );\n* var v = new Float32Vector( buf, 16 );\n* // returns \n*\n* var len = numel( v );\n* // returns 4\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var buf = new ArrayBuffer( 64 );\n* var v = new Float32Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( v );\n* // returns 2\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,QAAS,6BAA8B,EAAE,QAiFnDC,EAAgBD,EAAS,SAAU,EAKvCD,EAAO,QAAUE,ICdjB,IAAIC,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "factory", "Float32Vector", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index a92bbdd..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,175 +0,0 @@ - -{{alias}}( [options] ) - Returns a one-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.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A one-dimensional ndarray. - - Examples - -------- - > var arr = {{alias}}() - - - -{{alias}}( length[, options] ) - Returns a one-dimensional single-precision floating-point ndarray having a - specified length. - - Parameters - ---------- - length: integer - 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.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A one-dimensional ndarray. - - Examples - -------- - > var arr = {{alias}}( 5 ) - - > var len = {{alias:@stdlib/ndarray/numel}}( arr ) - 5 - - -{{alias}}( obj[, options] ) - Creates a one-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. - - 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.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A one-dimensional ndarray. - - Examples - -------- - > var v = [ 1.0, 2.0, 3.0 ]; - > var arr = {{alias}}( v ) - - > var len = {{alias:@stdlib/ndarray/numel}}( arr ) - 3 - - -{{alias}}( buffer[, byteOffset[, length]][, options] ) - Returns a one-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. - - length: integer (optional) - View length. If not provided, the view spans from the byteOffset to - the end of the underlying ArrayBuffer. - - 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.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A one-dimensional ndarray. - - Examples - -------- - > var buf = new {{alias:@stdlib/array/buffer}}( 32 ); - > var arr = {{alias}}( buf, 0, 4 ) - - > var len = {{alias:@stdlib/ndarray/numel}}( arr ) - 4 - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index c222353..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,86 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 Float32Vector = require( './index' ); - - -// TESTS // - -// The function returns an ndarray... -{ - new Float32Vector(); // $ExpectType float32ndarray - new Float32Vector( {} ); // $ExpectType float32ndarray - - new Float32Vector( 10 ); // $ExpectType float32ndarray - new Float32Vector( 10, {} ); // $ExpectType float32ndarray - - new Float32Vector( [ 1, 2, 3 ] ); // $ExpectType float32ndarray - new Float32Vector( [ 1, 2, 3 ], {} ); // $ExpectType float32ndarray - - new Float32Vector( new ArrayBuffer( 10 ) ); // $ExpectType float32ndarray - new Float32Vector( new ArrayBuffer( 10 ), {} ); // $ExpectType float32ndarray - - new Float32Vector( new ArrayBuffer( 10 ), 8 ); // $ExpectType float32ndarray - new Float32Vector( new ArrayBuffer( 10 ), 8, {} ); // $ExpectType float32ndarray - - new Float32Vector( new ArrayBuffer( 10 ), 8, 0 ); // $ExpectType float32ndarray - new Float32Vector( new ArrayBuffer( 10 ), 8, 0, {} ); // $ExpectType float32ndarray - - const vector = Float32Vector; - vector(); // $ExpectType float32ndarray - vector( {} ); // $ExpectType float32ndarray - - vector( 10 ); // $ExpectType float32ndarray - vector( 10, {} ); // $ExpectType float32ndarray - - vector( [ 1, 2, 3 ] ); // $ExpectType float32ndarray - vector( [ 1, 2, 3 ], {} ); // $ExpectType float32ndarray - - vector( new ArrayBuffer( 10 ) ); // $ExpectType float32ndarray - vector( new ArrayBuffer( 10 ), {} ); // $ExpectType float32ndarray - - vector( new ArrayBuffer( 10 ), 8 ); // $ExpectType float32ndarray - vector( new ArrayBuffer( 10 ), 8, {} ); // $ExpectType float32ndarray - - vector( new ArrayBuffer( 10 ), 8, 0 ); // $ExpectType float32ndarray - vector( new ArrayBuffer( 10 ), 8, 0, {} ); // $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 Float32Vector( true ); // $ExpectError - new Float32Vector( false ); // $ExpectError - new Float32Vector( null ); // $ExpectError - new Float32Vector( ( x: number ): number => x ); // $ExpectError - - const vector = Float32Vector; - vector( true ); // $ExpectError - vector( false ); // $ExpectError - vector( null ); // $ExpectError - vector( ( 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 Float32Vector( buf, 8, 2, {}, {} ); // $ExpectError - - const vector = Float32Vector; - vector( buf, 8, 2, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 24af996..0000000 --- a/examples/index.js +++ /dev/null @@ -1,43 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 Float32Vector = require( './../lib' ); - -// Create a vector containing random values: -var x = new Float32Vector( discreteUniform( 10, 0, 100 ) ); - -// Compute the sum: -var v = sum( x ); -console.log( v.get() ); - -// 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: -v = sum( y ); -console.log( v.get() ); 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 346c235..fe7ae4c 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 } from '@stdlib/types/ndarray'; import { Collection, AccessorArrayLike } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..3221a3c --- /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-vector-ctor@v0.1.1-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..0e99e27 --- /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) 2025 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* 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-vector-ctor';\n\n\n// MAIN //\n\n/**\n* Returns a single-precision floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Float32Vector\n* @type {Function}\n* @param {(NonNegativeInteger|Collection|ArrayBuffer|Iterable)} [arg] - length, typed array, array-like object, buffer, or iterable\n* @param {NonNegativeInteger} [byteOffset=0] - byte offset\n* @param {NonNegativeInteger} [length] - view length\n* @param {Options} [options] - function options\n* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only vector\n* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed vector dimensions\n* @param {string} [options.order='row-major'] - memory layout (either row-major or column-major)\n* @throws {TypeError} first argument must be either a length, typed array, array-like object, buffer, iterable, or options object\n* @throws {TypeError} must provide valid options\n* @returns {ndarray} one-dimensional ndarray\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector();\n* // returns \n*\n* var len = numel( arr );\n* // returns 0\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector( 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector( [ 1.0, 2.0 ] );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf );\n* // returns \n*\n* var len = numel( arr );\n* // returns 8\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf, 16 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 4\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 64 );\n* var arr = new Float32Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Float32Vector = factory( 'float32' );\n\n\n// EXPORTS //\n\nexport default Float32Vector;\n"],"names":["Float32Vector","factory"],"mappings":";;yGAuGG,IAACA,EAAgBC,EAAS"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 47c8cc7..0000000 --- a/lib/index.js +++ /dev/null @@ -1,100 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 vector (i.e., a one-dimensional ndarray). -* -* @module @stdlib/ndarray-vector-float32 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var v = new Float32Vector(); -* // returns -* -* var len = numel( v ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var v = new Float32Vector( 2 ); -* // returns -* -* var len = numel( v ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var v = new Float32Vector( [ 1.0, 2.0 ] ); -* // returns -* -* var len = numel( v ); -* // returns 2 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var buf = new ArrayBuffer( 32 ); -* var v = new Float32Vector( buf ); -* // returns -* -* var len = numel( v ); -* // returns 8 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var buf = new ArrayBuffer( 32 ); -* var v = new Float32Vector( buf, 16 ); -* // returns -* -* var len = numel( v ); -* // returns 4 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var buf = new ArrayBuffer( 64 ); -* var v = new Float32Vector( buf, 16, 2 ); -* // returns -* -* var len = numel( v ); -* // returns 2 -*/ - -// 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 853738a..0000000 --- a/lib/main.js +++ /dev/null @@ -1,109 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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-vector-ctor' ).factory; - - -// MAIN // - -/** -* Returns a single-precision floating-point vector (i.e., a one-dimensional ndarray). -* -* @name Float32Vector -* @type {Function} -* @param {(NonNegativeInteger|Collection|ArrayBuffer|Iterable)} [arg] - length, typed array, array-like object, buffer, or iterable -* @param {NonNegativeInteger} [byteOffset=0] - byte offset -* @param {NonNegativeInteger} [length] - view length -* @param {Options} [options] - function options -* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only vector -* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed vector dimensions -* @param {string} [options.order='row-major'] - memory layout (either row-major or column-major) -* @throws {TypeError} first argument must be either a length, typed array, array-like object, buffer, iterable, or options object -* @throws {TypeError} must provide valid options -* @returns {ndarray} one-dimensional ndarray -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector(); -* // returns -* -* var len = numel( arr ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector( 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector( [ 1.0, 2.0 ] ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 32 ); -* var arr = new Float32Vector( buf ); -* // returns -* -* var len = numel( arr ); -* // returns 8 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 32 ); -* var arr = new Float32Vector( buf, 16 ); -* // returns -* -* var len = numel( arr ); -* // returns 4 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 64 ); -* var arr = new Float32Vector( buf, 16, 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -*/ -var Float32Vector = factory( 'float32' ); - - -// EXPORTS // - -module.exports = Float32Vector; diff --git a/package.json b/package.json index 515f06f..9eed39e 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.1", "description": "Create a single-precision floating-point vector (i.e., a one-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,45 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/ndarray-vector-ctor": "^0.1.1", - "@stdlib/types": "^0.4.3" - }, - "devDependencies": { - "@stdlib/array-buffer": "^0.2.3", - "@stdlib/array-float32": "^0.2.3", - "@stdlib/array-float64": "^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/buffer-from-array": "^0.2.3", - "@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/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..f8585b0 --- /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 fff6e0e..0000000 --- a/test/test.js +++ /dev/null @@ -1,1022 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 Float64Array = require( '@stdlib/array-float64' ); -var Float32Array = require( '@stdlib/array-float32' ); -var getData = require( '@stdlib/ndarray-data-buffer' ); -var array2buffer = require( '@stdlib/buffer-from-array' ); -var Float32Vector = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof Float32Vector, '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, - function noop() {} - ]; - for ( i = 0; i < 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 Float32Vector( 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, - function noop() {} - ]; - for ( i = 0; i < 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 Float32Vector( value, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (byteoffset)', 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 Float32Vector( value, 0 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (byteoffset, 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 Float32Vector( value, 0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (byteoffset, length)', 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 Float32Vector( value, 0, 1 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (byteoffset, length, 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 Float32Vector( value, 0, 1, {} ); - }; - } -}); - -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 Float32Vector( 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 Float32Vector( new ArrayBuffer( 8 ), value, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid byte offset argument (length)', 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 Float32Vector( new ArrayBuffer( 8 ), value, 1 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid byte offset argument (length, 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 Float32Vector( new ArrayBuffer( 8 ), value, 1, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid length 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 Float32Vector( new ArrayBuffer( 8 ), 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid length 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 Float32Vector( new ArrayBuffer( 8 ), 0, value, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (length)', 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 Float32Vector( 10, 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 Float32Vector( [], 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 Float32Vector( 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 Float32Vector( new ArrayBuffer( 8 ), 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (arraybuffer, byteoffset, length)', 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 Float32Vector( new ArrayBuffer( 8 ), 0, 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 Float32Vector({ - '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 Float32Vector({ - 'mode': 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 Float32Vector({ - 'readonly': value - }); - }; - } -}); - -tape( 'the function returns a one-dimensional ndarray', function test( t ) { - var arr; - - arr = new Float32Vector(); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - - arr = new Float32Vector( {} ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (length)', function test( t ) { - var arr; - - arr = new Float32Vector( 10 ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, 'returns expected value' ); - - arr = new Float32Vector( 10, {} ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (array)', function test( t ) { - var arr; - var out; - - arr = [ 1.0, 2.0, 3.0, 4.0 ]; - - out = new Float32Vector( arr ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - out = new Float32Vector( arr, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (typed array)', function test( t ) { - var arr; - var out; - - arr = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - out = new Float32Vector( arr ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - out = new Float32Vector( arr, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (buffer)', function test( t ) { - var arr; - var out; - var buf; - - arr = [ 1, 2, 3, 4 ]; - buf = array2buffer( arr ); - - out = new Float32Vector( buf ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - out = new Float32Vector( buf, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (arraybuffer)', function test( t ) { - var buf; - var out; - - buf = new ArrayBuffer( 8 ); - - out = new Float32Vector( buf ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 2, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf ) ), true, 'returns expected value' ); - - out = new Float32Vector( buf, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 2, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (arraybuffer, byteoffset)', function test( t ) { - var buf; - var out; - - buf = new ArrayBuffer( 32 ); - - out = new Float32Vector( buf, 8 ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 6, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf, 8 ) ), true, 'returns expected value' ); - - out = new Float32Vector( buf, 8, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 6, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf, 8 ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (arraybuffer, byteoffset, length)', function test( t ) { - var buf; - var out; - - buf = new ArrayBuffer( 32 ); - - out = new Float32Vector( buf, 8, 2 ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 2, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf, 8, 2 ) ), true, 'returns expected value' ); - - out = new Float32Vector( buf, 8, 2, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( out.length, 2, '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 Float32Vector({ - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Float32Vector({ - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - t.strictEqual( arr.order, 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (length)', function test( t ) { - var arr; - - arr = new Float32Vector( 10, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Float32Vector( 10, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, 'returns expected value' ); - t.strictEqual( arr.order, 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (array)', function test( t ) { - var arr; - - arr = new Float32Vector( [ 1.0, 2.0, 3.0, 4.0 ], { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 4, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Float32Vector( [ 1.0, 2.0, 3.0, 4.0 ], { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 4, 'returns expected value' ); - t.strictEqual( arr.order, 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (arraybuffer)', function test( t ) { - var arr; - - arr = new Float32Vector( new ArrayBuffer( 32 ), { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 8, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Float32Vector( new ArrayBuffer( 32 ), { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 8, 'returns expected value' ); - t.strictEqual( arr.order, 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (arraybuffer, byteoffset)', function test( t ) { - var arr; - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 6, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 6, 'returns expected value' ); - t.strictEqual( arr.order, 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (arraybuffer, byteoffset, length)', function test( t ) { - var arr; - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, 2, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 2, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, 2, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 2, 'returns expected value' ); - t.strictEqual( arr.order, 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning read-only ndarrays', function test( t ) { - var arr; - - arr = new Float32Vector({ - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning read-only ndarrays (length)', function test( t ) { - var arr; - - arr = new Float32Vector( 10, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, '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 Float32Vector( [ 1.0, 2.0, 3.0, 4.0 ], { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 4, '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 Float32Vector( new ArrayBuffer( 32 ), { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 8, '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 Float32Vector( new ArrayBuffer( 32 ), 8, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 6, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning read-only ndarrays (arraybuffer, byteoffset, length)', function test( t ) { - var arr; - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, 2, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 2, '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 Float32Vector({ - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning writable ndarrays (length)', function test( t ) { - var arr; - - arr = new Float32Vector( 10, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, '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 Float32Vector( [ 1.0, 2.0, 3.0, 4.0 ], { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 4, '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 Float32Vector( new ArrayBuffer( 32 ), { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 8, '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 Float32Vector( new ArrayBuffer( 32 ), 8, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 6, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning writable ndarrays (arraybuffer, byteoffset, length)', function test( t ) { - var arr; - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, 2, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 2, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); From a50fde459f74bc7d2909fadcdef31401c44444ad Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 18 May 2026 12:20:57 +0000 Subject: [PATCH 37/42] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 607cc78..c619204 100644 --- a/package.json +++ b/package.json @@ -56,7 +56,7 @@ "@stdlib/ndarray-numel": "^0.2.3", "@stdlib/ndarray-order": "^0.2.3", "@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 5a8ec6a9ef9713764130b4a41699837d69570232 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 18 May 2026 12:35:05 +0000 Subject: [PATCH 38/42] Remove files --- index.d.ts | 377 ---- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5224 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 fe7ae4c..0000000 --- a/index.d.ts +++ /dev/null @@ -1,377 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 } from '@stdlib/types/ndarray'; -import { Collection, AccessorArrayLike } 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; - - /** - * Boolean indicating whether an array should be read-only (default: false). - */ - readonly?: boolean; -} - -/** -* Interface defining a typed vector constructor which is both "newable" and "callable". -*/ -interface Float32Vector { - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector(); - * // returns - * - * var len = numel( arr ); - * // returns 0 - */ - new ( options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param length - vector length - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector( 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( length: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param obj - array-like object or iterable from which to generate a vector - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector( [ 1.0, 2.0 ] ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( obj: Collection | AccessorArrayLike | Iterable, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Vector( buf ); - * // returns - * - * var len = numel( arr ); - * // returns 8 - */ - new ( buffer: ArrayBuffer, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param byteOffset - integer byte offset specifying the location of the first vector element - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Vector( buf, 8 ); - * // returns - * - * var len = numel( arr ); - * // returns 6 - */ - new ( buffer: ArrayBuffer, byteOffset: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param byteOffset - integer byte offset specifying the location of the first vector element - * @param length - view length; if not provided, the view spans from the byteOffset to the end of the underlying ArrayBuffer - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Vector( buf, 8, 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( buffer: ArrayBuffer, byteOffset: number, length: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector(); - * // returns - * - * var len = numel( arr ); - * // returns 0 - */ - ( options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param length - vector length - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector( 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( length: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param obj - array-like object or iterable from which to generate a vector - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector( [ 1.0, 2.0 ] ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( obj: Collection | AccessorArrayLike | Iterable, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Vector( buf ); - * // returns - * - * var len = numel( arr ); - * // returns 8 - */ - ( buffer: ArrayBuffer, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param byteOffset - integer byte offset specifying the location of the first vector element - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Vector( buf, 8 ); - * // returns - * - * var len = numel( arr ); - * // returns 6 - */ - ( buffer: ArrayBuffer, byteOffset: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param byteOffset - integer byte offset specifying the location of the first vector element - * @param length - view length; if not provided, the view spans from the byteOffset to the end of the underlying ArrayBuffer - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Vector( buf, 8, 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( buffer: ArrayBuffer, byteOffset: number, length: number, options?: Options ): float32ndarray; -} - -/** -* Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). -* -* @param arg - length, typed array, array-like object, buffer, or iterable -* @param byteOffset - integer byte offset specifying the location of the first vector element (default: 0) -* @param length - view length; if not provided, the view spans from the byteOffset to the end of the underlying ArrayBuffer -* @param options - function options -* @param options.readonly - boolean indicating whether to return a read-only vector -* @param options.mode - specifies how to handle indices which exceed vector dimensions -* @param options.order - memory layout (either row-major or column-major) -* @returns one-dimensional ndarray -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector(); -* // returns -* -* var len = numel( arr ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector( 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector( [ 1.0, 2.0 ] ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 32 ); -* var arr = new Float32Vector( buf, 8, 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -*/ -declare var ctor: Float32Vector; - - -// EXPORTS // - -export = ctor; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 3221a3c..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-vector-ctor@v0.1.1-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 0e99e27..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) 2025 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* 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-vector-ctor';\n\n\n// MAIN //\n\n/**\n* Returns a single-precision floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Float32Vector\n* @type {Function}\n* @param {(NonNegativeInteger|Collection|ArrayBuffer|Iterable)} [arg] - length, typed array, array-like object, buffer, or iterable\n* @param {NonNegativeInteger} [byteOffset=0] - byte offset\n* @param {NonNegativeInteger} [length] - view length\n* @param {Options} [options] - function options\n* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only vector\n* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed vector dimensions\n* @param {string} [options.order='row-major'] - memory layout (either row-major or column-major)\n* @throws {TypeError} first argument must be either a length, typed array, array-like object, buffer, iterable, or options object\n* @throws {TypeError} must provide valid options\n* @returns {ndarray} one-dimensional ndarray\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector();\n* // returns \n*\n* var len = numel( arr );\n* // returns 0\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector( 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector( [ 1.0, 2.0 ] );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf );\n* // returns \n*\n* var len = numel( arr );\n* // returns 8\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf, 16 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 4\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 64 );\n* var arr = new Float32Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Float32Vector = factory( 'float32' );\n\n\n// EXPORTS //\n\nexport default Float32Vector;\n"],"names":["Float32Vector","factory"],"mappings":";;yGAuGG,IAACA,EAAgBC,EAAS"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index f8585b0..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From cfa035325b9e3474f8036d190fa511ff132e8b9f Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 18 May 2026 12:35:31 +0000 Subject: [PATCH 39/42] 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 | 31 - CHANGELOG.md | 99 - 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 | 94 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 175 - docs/types/test.ts | 86 - examples/index.js | 43 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 100 - lib/main.js | 109 - package.json | 68 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 1024 ---- 44 files changed, 4877 insertions(+), 5386 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 a8a68fb..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/vector/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 f21cc2e..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/vector/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 d88538c..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: '0 0 * * 3' - - # 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 + + ```
@@ -235,7 +226,7 @@ console.log( v.get() ); ## 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]. @@ -298,19 +289,19 @@ Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-vector-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/vector/float64]: https://github.com/stdlib-js/ndarray-vector-float64 +[@stdlib/ndarray/vector/float64]: https://github.com/stdlib-js/ndarray-vector-float64/tree/esm -[@stdlib/ndarray/vector/complex128]: https://github.com/stdlib-js/ndarray-vector-complex128 +[@stdlib/ndarray/vector/complex128]: https://github.com/stdlib-js/ndarray-vector-complex128/tree/esm -[@stdlib/ndarray/vector/complex64]: https://github.com/stdlib-js/ndarray-vector-complex64 +[@stdlib/ndarray/vector/complex64]: https://github.com/stdlib-js/ndarray-vector-complex64/tree/esm -[@stdlib/ndarray/vector/ctor]: https://github.com/stdlib-js/ndarray-vector-ctor +[@stdlib/ndarray/vector/ctor]: https://github.com/stdlib-js/ndarray-vector-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 7418c03..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,47 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* 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 Float32Vector = require( './../lib' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var arr; - var i; - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr = new Float32Vector( 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 cdc4b8c..0000000 --- a/benchmark/benchmark.size.js +++ /dev/null @@ -1,94 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* 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 isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var Float32Vector = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var arr; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr = new Float32Vector( len ); - if ( arr.length !== len ) { - b.fail( 'unexpected length' ); - } - } - 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 len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( format( '%s:size=%d', pkg, len ), f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 6d01049..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/vector/float32" -%% click B href "https://github.com/stdlib-js/ndarray-vector-float32/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-vector-float32/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-vector-float32/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-vector-float32/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-vector-float32/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/vector/float32 -[production-url]: https://github.com/stdlib-js/ndarray-vector-float32/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-vector-float32/tree/deno -[deno-readme]: https://github.com/stdlib-js/ndarray-vector-float32/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/ndarray-vector-float32/tree/umd -[umd-readme]: https://github.com/stdlib-js/ndarray-vector-float32/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/ndarray-vector-float32/tree/esm -[esm-readme]: https://github.com/stdlib-js/ndarray-vector-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 7c5ecb1..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var o=function(a,r){return function(){return r||a((r={exports:{}}).exports,r),r.exports}};var e=o(function(f,t){ -var s=require('@stdlib/ndarray-vector-ctor/dist').factory,c=s("float32");t.exports=c -});var i=e();module.exports=i; -/** @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 a14f526..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) 2025 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* 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-vector-ctor' ).factory;\n\n\n// MAIN //\n\n/**\n* Returns a single-precision floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Float32Vector\n* @type {Function}\n* @param {(NonNegativeInteger|Collection|ArrayBuffer|Iterable)} [arg] - length, typed array, array-like object, buffer, or iterable\n* @param {NonNegativeInteger} [byteOffset=0] - byte offset\n* @param {NonNegativeInteger} [length] - view length\n* @param {Options} [options] - function options\n* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only vector\n* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed vector dimensions\n* @param {string} [options.order='row-major'] - memory layout (either row-major or column-major)\n* @throws {TypeError} first argument must be either a length, typed array, array-like object, buffer, iterable, or options object\n* @throws {TypeError} must provide valid options\n* @returns {ndarray} one-dimensional ndarray\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n*\n* var arr = new Float32Vector();\n* // returns \n*\n* var len = numel( arr );\n* // returns 0\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n*\n* var arr = new Float32Vector( 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n*\n* var arr = new Float32Vector( [ 1.0, 2.0 ] );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf );\n* // returns \n*\n* var len = numel( arr );\n* // returns 8\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf, 16 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 4\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n*\n* var buf = new ArrayBuffer( 64 );\n* var arr = new Float32Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Float32Vector = factory( 'float32' );\n\n\n// EXPORTS //\n\nmodule.exports = Float32Vector;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 vector (i.e., a one-dimensional ndarray).\n*\n* @module @stdlib/ndarray-vector-float32\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var v = new Float32Vector();\n* // returns \n*\n* var len = numel( v );\n* // returns 0\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var v = new Float32Vector( 2 );\n* // returns \n*\n* var len = numel( v );\n* // returns 2\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var v = new Float32Vector( [ 1.0, 2.0 ] );\n* // returns \n*\n* var len = numel( v );\n* // returns 2\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var buf = new ArrayBuffer( 32 );\n* var v = new Float32Vector( buf );\n* // returns \n*\n* var len = numel( v );\n* // returns 8\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var buf = new ArrayBuffer( 32 );\n* var v = new Float32Vector( buf, 16 );\n* // returns \n*\n* var len = numel( v );\n* // returns 4\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var buf = new ArrayBuffer( 64 );\n* var v = new Float32Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( v );\n* // returns 2\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,QAAS,6BAA8B,EAAE,QAiFnDC,EAAgBD,EAAS,SAAU,EAKvCD,EAAO,QAAUE,ICdjB,IAAIC,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "factory", "Float32Vector", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index a92bbdd..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,175 +0,0 @@ - -{{alias}}( [options] ) - Returns a one-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.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A one-dimensional ndarray. - - Examples - -------- - > var arr = {{alias}}() - - - -{{alias}}( length[, options] ) - Returns a one-dimensional single-precision floating-point ndarray having a - specified length. - - Parameters - ---------- - length: integer - 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.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A one-dimensional ndarray. - - Examples - -------- - > var arr = {{alias}}( 5 ) - - > var len = {{alias:@stdlib/ndarray/numel}}( arr ) - 5 - - -{{alias}}( obj[, options] ) - Creates a one-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. - - 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.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A one-dimensional ndarray. - - Examples - -------- - > var v = [ 1.0, 2.0, 3.0 ]; - > var arr = {{alias}}( v ) - - > var len = {{alias:@stdlib/ndarray/numel}}( arr ) - 3 - - -{{alias}}( buffer[, byteOffset[, length]][, options] ) - Returns a one-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. - - length: integer (optional) - View length. If not provided, the view spans from the byteOffset to - the end of the underlying ArrayBuffer. - - 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.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A one-dimensional ndarray. - - Examples - -------- - > var buf = new {{alias:@stdlib/array/buffer}}( 32 ); - > var arr = {{alias}}( buf, 0, 4 ) - - > var len = {{alias:@stdlib/ndarray/numel}}( arr ) - 4 - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index c222353..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,86 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 Float32Vector = require( './index' ); - - -// TESTS // - -// The function returns an ndarray... -{ - new Float32Vector(); // $ExpectType float32ndarray - new Float32Vector( {} ); // $ExpectType float32ndarray - - new Float32Vector( 10 ); // $ExpectType float32ndarray - new Float32Vector( 10, {} ); // $ExpectType float32ndarray - - new Float32Vector( [ 1, 2, 3 ] ); // $ExpectType float32ndarray - new Float32Vector( [ 1, 2, 3 ], {} ); // $ExpectType float32ndarray - - new Float32Vector( new ArrayBuffer( 10 ) ); // $ExpectType float32ndarray - new Float32Vector( new ArrayBuffer( 10 ), {} ); // $ExpectType float32ndarray - - new Float32Vector( new ArrayBuffer( 10 ), 8 ); // $ExpectType float32ndarray - new Float32Vector( new ArrayBuffer( 10 ), 8, {} ); // $ExpectType float32ndarray - - new Float32Vector( new ArrayBuffer( 10 ), 8, 0 ); // $ExpectType float32ndarray - new Float32Vector( new ArrayBuffer( 10 ), 8, 0, {} ); // $ExpectType float32ndarray - - const vector = Float32Vector; - vector(); // $ExpectType float32ndarray - vector( {} ); // $ExpectType float32ndarray - - vector( 10 ); // $ExpectType float32ndarray - vector( 10, {} ); // $ExpectType float32ndarray - - vector( [ 1, 2, 3 ] ); // $ExpectType float32ndarray - vector( [ 1, 2, 3 ], {} ); // $ExpectType float32ndarray - - vector( new ArrayBuffer( 10 ) ); // $ExpectType float32ndarray - vector( new ArrayBuffer( 10 ), {} ); // $ExpectType float32ndarray - - vector( new ArrayBuffer( 10 ), 8 ); // $ExpectType float32ndarray - vector( new ArrayBuffer( 10 ), 8, {} ); // $ExpectType float32ndarray - - vector( new ArrayBuffer( 10 ), 8, 0 ); // $ExpectType float32ndarray - vector( new ArrayBuffer( 10 ), 8, 0, {} ); // $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 Float32Vector( true ); // $ExpectError - new Float32Vector( false ); // $ExpectError - new Float32Vector( null ); // $ExpectError - new Float32Vector( ( x: number ): number => x ); // $ExpectError - - const vector = Float32Vector; - vector( true ); // $ExpectError - vector( false ); // $ExpectError - vector( null ); // $ExpectError - vector( ( 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 Float32Vector( buf, 8, 2, {}, {} ); // $ExpectError - - const vector = Float32Vector; - vector( buf, 8, 2, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 24af996..0000000 --- a/examples/index.js +++ /dev/null @@ -1,43 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 Float32Vector = require( './../lib' ); - -// Create a vector containing random values: -var x = new Float32Vector( discreteUniform( 10, 0, 100 ) ); - -// Compute the sum: -var v = sum( x ); -console.log( v.get() ); - -// 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: -v = sum( y ); -console.log( v.get() ); 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 346c235..fe7ae4c 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 } from '@stdlib/types/ndarray'; import { Collection, AccessorArrayLike } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..3221a3c --- /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-vector-ctor@v0.1.1-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..0e99e27 --- /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) 2025 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* 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-vector-ctor';\n\n\n// MAIN //\n\n/**\n* Returns a single-precision floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Float32Vector\n* @type {Function}\n* @param {(NonNegativeInteger|Collection|ArrayBuffer|Iterable)} [arg] - length, typed array, array-like object, buffer, or iterable\n* @param {NonNegativeInteger} [byteOffset=0] - byte offset\n* @param {NonNegativeInteger} [length] - view length\n* @param {Options} [options] - function options\n* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only vector\n* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed vector dimensions\n* @param {string} [options.order='row-major'] - memory layout (either row-major or column-major)\n* @throws {TypeError} first argument must be either a length, typed array, array-like object, buffer, iterable, or options object\n* @throws {TypeError} must provide valid options\n* @returns {ndarray} one-dimensional ndarray\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector();\n* // returns \n*\n* var len = numel( arr );\n* // returns 0\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector( 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector( [ 1.0, 2.0 ] );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf );\n* // returns \n*\n* var len = numel( arr );\n* // returns 8\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf, 16 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 4\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 64 );\n* var arr = new Float32Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Float32Vector = factory( 'float32' );\n\n\n// EXPORTS //\n\nexport default Float32Vector;\n"],"names":["Float32Vector","factory"],"mappings":";;yGAuGG,IAACA,EAAgBC,EAAS"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 47c8cc7..0000000 --- a/lib/index.js +++ /dev/null @@ -1,100 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 vector (i.e., a one-dimensional ndarray). -* -* @module @stdlib/ndarray-vector-float32 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var v = new Float32Vector(); -* // returns -* -* var len = numel( v ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var v = new Float32Vector( 2 ); -* // returns -* -* var len = numel( v ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var v = new Float32Vector( [ 1.0, 2.0 ] ); -* // returns -* -* var len = numel( v ); -* // returns 2 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var buf = new ArrayBuffer( 32 ); -* var v = new Float32Vector( buf ); -* // returns -* -* var len = numel( v ); -* // returns 8 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var buf = new ArrayBuffer( 32 ); -* var v = new Float32Vector( buf, 16 ); -* // returns -* -* var len = numel( v ); -* // returns 4 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var buf = new ArrayBuffer( 64 ); -* var v = new Float32Vector( buf, 16, 2 ); -* // returns -* -* var len = numel( v ); -* // returns 2 -*/ - -// 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 853738a..0000000 --- a/lib/main.js +++ /dev/null @@ -1,109 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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-vector-ctor' ).factory; - - -// MAIN // - -/** -* Returns a single-precision floating-point vector (i.e., a one-dimensional ndarray). -* -* @name Float32Vector -* @type {Function} -* @param {(NonNegativeInteger|Collection|ArrayBuffer|Iterable)} [arg] - length, typed array, array-like object, buffer, or iterable -* @param {NonNegativeInteger} [byteOffset=0] - byte offset -* @param {NonNegativeInteger} [length] - view length -* @param {Options} [options] - function options -* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only vector -* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed vector dimensions -* @param {string} [options.order='row-major'] - memory layout (either row-major or column-major) -* @throws {TypeError} first argument must be either a length, typed array, array-like object, buffer, iterable, or options object -* @throws {TypeError} must provide valid options -* @returns {ndarray} one-dimensional ndarray -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector(); -* // returns -* -* var len = numel( arr ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector( 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector( [ 1.0, 2.0 ] ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 32 ); -* var arr = new Float32Vector( buf ); -* // returns -* -* var len = numel( arr ); -* // returns 8 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 32 ); -* var arr = new Float32Vector( buf, 16 ); -* // returns -* -* var len = numel( arr ); -* // returns 4 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 64 ); -* var arr = new Float32Vector( buf, 16, 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -*/ -var Float32Vector = factory( 'float32' ); - - -// EXPORTS // - -module.exports = Float32Vector; diff --git a/package.json b/package.json index c619204..9eed39e 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.1", "description": "Create a single-precision floating-point vector (i.e., a one-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-vector-ctor": "^0.1.1", - "@stdlib/types": "^0.4.3" - }, - "devDependencies": { - "@stdlib/array-buffer": "^0.2.3", - "@stdlib/array-float32": "^0.2.3", - "@stdlib/array-float64": "^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/buffer-from-array": "^0.2.3", - "@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-numel": "^0.2.3", - "@stdlib/ndarray-order": "^0.2.3", - "@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..f8585b0 --- /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 950f063..0000000 --- a/test/test.js +++ /dev/null @@ -1,1024 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 Float64Array = require( '@stdlib/array-float64' ); -var Float32Array = require( '@stdlib/array-float32' ); -var getData = require( '@stdlib/ndarray-data-buffer' ); -var array2buffer = require( '@stdlib/buffer-from-array' ); -var numel = require( '@stdlib/ndarray-numel' ); -var getOrder = require( '@stdlib/ndarray-order' ); -var Float32Vector = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof Float32Vector, '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, - function noop() {} - ]; - for ( i = 0; i < 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 Float32Vector( 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, - function noop() {} - ]; - for ( i = 0; i < 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 Float32Vector( value, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (byteoffset)', 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 Float32Vector( value, 0 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (byteoffset, 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 Float32Vector( value, 0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (byteoffset, length)', 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 Float32Vector( value, 0, 1 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (byteoffset, length, 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 Float32Vector( value, 0, 1, {} ); - }; - } -}); - -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 Float32Vector( 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 Float32Vector( new ArrayBuffer( 8 ), value, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid byte offset argument (length)', 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 Float32Vector( new ArrayBuffer( 8 ), value, 1 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid byte offset argument (length, 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 Float32Vector( new ArrayBuffer( 8 ), value, 1, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid length 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 Float32Vector( new ArrayBuffer( 8 ), 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid length 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 Float32Vector( new ArrayBuffer( 8 ), 0, value, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (length)', 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 Float32Vector( 10, 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 Float32Vector( [], 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 Float32Vector( 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 Float32Vector( new ArrayBuffer( 8 ), 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (arraybuffer, byteoffset, length)', 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 Float32Vector( new ArrayBuffer( 8 ), 0, 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 Float32Vector({ - '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 Float32Vector({ - 'mode': 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 Float32Vector({ - 'readonly': value - }); - }; - } -}); - -tape( 'the function returns a one-dimensional ndarray', function test( t ) { - var arr; - - arr = new Float32Vector(); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 0, 'returns expected value' ); - - arr = new Float32Vector( {} ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 0, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (length)', function test( t ) { - var arr; - - arr = new Float32Vector( 10 ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 10, 'returns expected value' ); - - arr = new Float32Vector( 10, {} ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 10, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (array)', function test( t ) { - var arr; - var out; - - arr = [ 1.0, 2.0, 3.0, 4.0 ]; - - out = new Float32Vector( arr ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - out = new Float32Vector( arr, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (typed array)', function test( t ) { - var arr; - var out; - - arr = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - out = new Float32Vector( arr ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - out = new Float32Vector( arr, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (buffer)', function test( t ) { - var arr; - var out; - var buf; - - arr = [ 1, 2, 3, 4 ]; - buf = array2buffer( arr ); - - out = new Float32Vector( buf ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - out = new Float32Vector( buf, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (arraybuffer)', function test( t ) { - var buf; - var out; - - buf = new ArrayBuffer( 8 ); - - out = new Float32Vector( buf ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 2, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf ) ), true, 'returns expected value' ); - - out = new Float32Vector( buf, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 2, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (arraybuffer, byteoffset)', function test( t ) { - var buf; - var out; - - buf = new ArrayBuffer( 32 ); - - out = new Float32Vector( buf, 8 ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 6, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf, 8 ) ), true, 'returns expected value' ); - - out = new Float32Vector( buf, 8, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 6, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf, 8 ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (arraybuffer, byteoffset, length)', function test( t ) { - var buf; - var out; - - buf = new ArrayBuffer( 32 ); - - out = new Float32Vector( buf, 8, 2 ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 2, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf, 8, 2 ) ), true, 'returns expected value' ); - - out = new Float32Vector( buf, 8, 2, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 2, '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 Float32Vector({ - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 0, 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Float32Vector({ - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 0, 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (length)', function test( t ) { - var arr; - - arr = new Float32Vector( 10, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 10, 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Float32Vector( 10, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 10, '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 Float32Vector( [ 1.0, 2.0, 3.0, 4.0 ], { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 4, 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Float32Vector( [ 1.0, 2.0, 3.0, 4.0 ], { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 4, '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 Float32Vector( new ArrayBuffer( 32 ), { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 8, 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Float32Vector( new ArrayBuffer( 32 ), { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 8, '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 Float32Vector( new ArrayBuffer( 32 ), 8, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 6, 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 6, 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (arraybuffer, byteoffset, length)', function test( t ) { - var arr; - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, 2, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 2, 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, 2, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 2, '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 Float32Vector({ - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 0, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning read-only ndarrays (length)', function test( t ) { - var arr; - - arr = new Float32Vector( 10, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 10, '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 Float32Vector( [ 1.0, 2.0, 3.0, 4.0 ], { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 4, '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 Float32Vector( new ArrayBuffer( 32 ), { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 8, '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 Float32Vector( new ArrayBuffer( 32 ), 8, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 6, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning read-only ndarrays (arraybuffer, byteoffset, length)', function test( t ) { - var arr; - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, 2, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 2, '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 Float32Vector({ - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 0, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning writable ndarrays (length)', function test( t ) { - var arr; - - arr = new Float32Vector( 10, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 10, '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 Float32Vector( [ 1.0, 2.0, 3.0, 4.0 ], { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 4, '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 Float32Vector( new ArrayBuffer( 32 ), { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 8, '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 Float32Vector( new ArrayBuffer( 32 ), 8, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 6, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning writable ndarrays (arraybuffer, byteoffset, length)', function test( t ) { - var arr; - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, 2, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 2, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); From e17bdcf588636af40f61702e06fd79e86b061765 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 21 May 2026 03:24:30 +0000 Subject: [PATCH 40/42] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 607cc78..c619204 100644 --- a/package.json +++ b/package.json @@ -56,7 +56,7 @@ "@stdlib/ndarray-numel": "^0.2.3", "@stdlib/ndarray-order": "^0.2.3", "@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 8d6818468b39cea40e21bc9028e8afe0e6a69c30 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 21 May 2026 03:32:13 +0000 Subject: [PATCH 41/42] Remove files --- index.d.ts | 377 ---- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5224 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 fe7ae4c..0000000 --- a/index.d.ts +++ /dev/null @@ -1,377 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 } from '@stdlib/types/ndarray'; -import { Collection, AccessorArrayLike } 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; - - /** - * Boolean indicating whether an array should be read-only (default: false). - */ - readonly?: boolean; -} - -/** -* Interface defining a typed vector constructor which is both "newable" and "callable". -*/ -interface Float32Vector { - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector(); - * // returns - * - * var len = numel( arr ); - * // returns 0 - */ - new ( options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param length - vector length - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector( 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( length: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param obj - array-like object or iterable from which to generate a vector - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector( [ 1.0, 2.0 ] ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( obj: Collection | AccessorArrayLike | Iterable, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Vector( buf ); - * // returns - * - * var len = numel( arr ); - * // returns 8 - */ - new ( buffer: ArrayBuffer, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param byteOffset - integer byte offset specifying the location of the first vector element - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Vector( buf, 8 ); - * // returns - * - * var len = numel( arr ); - * // returns 6 - */ - new ( buffer: ArrayBuffer, byteOffset: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param byteOffset - integer byte offset specifying the location of the first vector element - * @param length - view length; if not provided, the view spans from the byteOffset to the end of the underlying ArrayBuffer - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Vector( buf, 8, 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( buffer: ArrayBuffer, byteOffset: number, length: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector(); - * // returns - * - * var len = numel( arr ); - * // returns 0 - */ - ( options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param length - vector length - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector( 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( length: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param obj - array-like object or iterable from which to generate a vector - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * - * var arr = new Float32Vector( [ 1.0, 2.0 ] ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( obj: Collection | AccessorArrayLike | Iterable, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Vector( buf ); - * // returns - * - * var len = numel( arr ); - * // returns 8 - */ - ( buffer: ArrayBuffer, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param byteOffset - integer byte offset specifying the location of the first vector element - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Vector( buf, 8 ); - * // returns - * - * var len = numel( arr ); - * // returns 6 - */ - ( buffer: ArrayBuffer, byteOffset: number, options?: Options ): float32ndarray; - - /** - * Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). - * - * @param buffer - underlying ArrayBuffer - * @param byteOffset - integer byte offset specifying the location of the first vector element - * @param length - view length; if not provided, the view spans from the byteOffset to the end of the underlying ArrayBuffer - * @param options - function options - * @param options.readonly - boolean indicating whether to return a read-only vector - * @param options.mode - specifies how to handle indices which exceed vector dimensions - * @param options.order - memory layout (either row-major or column-major) - * @returns one-dimensional ndarray - * - * @example - * var numel = require( '@stdlib/ndarray-numel' ); - * var ArrayBuffer = require( '@stdlib/array-buffer' ); - * - * var buf = new ArrayBuffer( 32 ); - * var arr = new Float32Vector( buf, 8, 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( buffer: ArrayBuffer, byteOffset: number, length: number, options?: Options ): float32ndarray; -} - -/** -* Creates a single-precision floating-point vector (i.e., a one-dimensional ndarray). -* -* @param arg - length, typed array, array-like object, buffer, or iterable -* @param byteOffset - integer byte offset specifying the location of the first vector element (default: 0) -* @param length - view length; if not provided, the view spans from the byteOffset to the end of the underlying ArrayBuffer -* @param options - function options -* @param options.readonly - boolean indicating whether to return a read-only vector -* @param options.mode - specifies how to handle indices which exceed vector dimensions -* @param options.order - memory layout (either row-major or column-major) -* @returns one-dimensional ndarray -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector(); -* // returns -* -* var len = numel( arr ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector( 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector( [ 1.0, 2.0 ] ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 32 ); -* var arr = new Float32Vector( buf, 8, 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -*/ -declare var ctor: Float32Vector; - - -// EXPORTS // - -export = ctor; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 3221a3c..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-vector-ctor@v0.1.1-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 0e99e27..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) 2025 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* 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-vector-ctor';\n\n\n// MAIN //\n\n/**\n* Returns a single-precision floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Float32Vector\n* @type {Function}\n* @param {(NonNegativeInteger|Collection|ArrayBuffer|Iterable)} [arg] - length, typed array, array-like object, buffer, or iterable\n* @param {NonNegativeInteger} [byteOffset=0] - byte offset\n* @param {NonNegativeInteger} [length] - view length\n* @param {Options} [options] - function options\n* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only vector\n* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed vector dimensions\n* @param {string} [options.order='row-major'] - memory layout (either row-major or column-major)\n* @throws {TypeError} first argument must be either a length, typed array, array-like object, buffer, iterable, or options object\n* @throws {TypeError} must provide valid options\n* @returns {ndarray} one-dimensional ndarray\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector();\n* // returns \n*\n* var len = numel( arr );\n* // returns 0\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector( 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector( [ 1.0, 2.0 ] );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf );\n* // returns \n*\n* var len = numel( arr );\n* // returns 8\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf, 16 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 4\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 64 );\n* var arr = new Float32Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Float32Vector = factory( 'float32' );\n\n\n// EXPORTS //\n\nexport default Float32Vector;\n"],"names":["Float32Vector","factory"],"mappings":";;yGAuGG,IAACA,EAAgBC,EAAS"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index f8585b0..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 448a6b1e5f8d3bfd94b8cb5430028517fdeaedf0 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 21 May 2026 03:32:59 +0000 Subject: [PATCH 42/42] 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 | 99 - 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 | 94 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 5 - dist/index.js.map | 7 - docs/repl.txt | 175 - docs/types/test.ts | 86 - examples/index.js | 43 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 100 - lib/main.js | 109 - package.json | 68 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 1024 ---- 45 files changed, 4877 insertions(+), 5400 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 21dd30e..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2026-05-21T03:22:40.606Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index a8a68fb..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/vector/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 f21cc2e..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/vector/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 d88538c..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: '0 0 * * 3' - - # 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 + + ```
@@ -235,7 +226,7 @@ console.log( v.get() ); ## 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]. @@ -298,19 +289,19 @@ Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-vector-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/vector/float64]: https://github.com/stdlib-js/ndarray-vector-float64 +[@stdlib/ndarray/vector/float64]: https://github.com/stdlib-js/ndarray-vector-float64/tree/esm -[@stdlib/ndarray/vector/complex128]: https://github.com/stdlib-js/ndarray-vector-complex128 +[@stdlib/ndarray/vector/complex128]: https://github.com/stdlib-js/ndarray-vector-complex128/tree/esm -[@stdlib/ndarray/vector/complex64]: https://github.com/stdlib-js/ndarray-vector-complex64 +[@stdlib/ndarray/vector/complex64]: https://github.com/stdlib-js/ndarray-vector-complex64/tree/esm -[@stdlib/ndarray/vector/ctor]: https://github.com/stdlib-js/ndarray-vector-ctor +[@stdlib/ndarray/vector/ctor]: https://github.com/stdlib-js/ndarray-vector-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 7418c03..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,47 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* 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 Float32Vector = require( './../lib' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var arr; - var i; - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr = new Float32Vector( 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 cdc4b8c..0000000 --- a/benchmark/benchmark.size.js +++ /dev/null @@ -1,94 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* 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 isndarrayLike = require( '@stdlib/assert-is-ndarray-like' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var Float32Vector = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var arr; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr = new Float32Vector( len ); - if ( arr.length !== len ) { - b.fail( 'unexpected length' ); - } - } - 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 len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( format( '%s:size=%d', pkg, len ), f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 6d01049..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/vector/float32" -%% click B href "https://github.com/stdlib-js/ndarray-vector-float32/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-vector-float32/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-vector-float32/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-vector-float32/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-vector-float32/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/vector/float32 -[production-url]: https://github.com/stdlib-js/ndarray-vector-float32/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-vector-float32/tree/deno -[deno-readme]: https://github.com/stdlib-js/ndarray-vector-float32/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/ndarray-vector-float32/tree/umd -[umd-readme]: https://github.com/stdlib-js/ndarray-vector-float32/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/ndarray-vector-float32/tree/esm -[esm-readme]: https://github.com/stdlib-js/ndarray-vector-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 7c5ecb1..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var o=function(a,r){return function(){return r||a((r={exports:{}}).exports,r),r.exports}};var e=o(function(f,t){ -var s=require('@stdlib/ndarray-vector-ctor/dist').factory,c=s("float32");t.exports=c -});var i=e();module.exports=i; -/** @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 a14f526..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) 2025 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* 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-vector-ctor' ).factory;\n\n\n// MAIN //\n\n/**\n* Returns a single-precision floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Float32Vector\n* @type {Function}\n* @param {(NonNegativeInteger|Collection|ArrayBuffer|Iterable)} [arg] - length, typed array, array-like object, buffer, or iterable\n* @param {NonNegativeInteger} [byteOffset=0] - byte offset\n* @param {NonNegativeInteger} [length] - view length\n* @param {Options} [options] - function options\n* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only vector\n* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed vector dimensions\n* @param {string} [options.order='row-major'] - memory layout (either row-major or column-major)\n* @throws {TypeError} first argument must be either a length, typed array, array-like object, buffer, iterable, or options object\n* @throws {TypeError} must provide valid options\n* @returns {ndarray} one-dimensional ndarray\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n*\n* var arr = new Float32Vector();\n* // returns \n*\n* var len = numel( arr );\n* // returns 0\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n*\n* var arr = new Float32Vector( 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n*\n* var arr = new Float32Vector( [ 1.0, 2.0 ] );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf );\n* // returns \n*\n* var len = numel( arr );\n* // returns 8\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf, 16 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 4\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n*\n* var buf = new ArrayBuffer( 64 );\n* var arr = new Float32Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Float32Vector = factory( 'float32' );\n\n\n// EXPORTS //\n\nmodule.exports = Float32Vector;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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 vector (i.e., a one-dimensional ndarray).\n*\n* @module @stdlib/ndarray-vector-float32\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var v = new Float32Vector();\n* // returns \n*\n* var len = numel( v );\n* // returns 0\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var v = new Float32Vector( 2 );\n* // returns \n*\n* var len = numel( v );\n* // returns 2\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var v = new Float32Vector( [ 1.0, 2.0 ] );\n* // returns \n*\n* var len = numel( v );\n* // returns 2\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var buf = new ArrayBuffer( 32 );\n* var v = new Float32Vector( buf );\n* // returns \n*\n* var len = numel( v );\n* // returns 8\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var buf = new ArrayBuffer( 32 );\n* var v = new Float32Vector( buf, 16 );\n* // returns \n*\n* var len = numel( v );\n* // returns 4\n*\n* @example\n* var ArrayBuffer = require( '@stdlib/array-buffer' );\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Float32Vector = require( '@stdlib/ndarray-vector-float32' );\n*\n* var buf = new ArrayBuffer( 64 );\n* var v = new Float32Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( v );\n* // returns 2\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,QAAS,6BAA8B,EAAE,QAiFnDC,EAAgBD,EAAS,SAAU,EAKvCD,EAAO,QAAUE,ICdjB,IAAIC,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "factory", "Float32Vector", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index a92bbdd..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,175 +0,0 @@ - -{{alias}}( [options] ) - Returns a one-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.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A one-dimensional ndarray. - - Examples - -------- - > var arr = {{alias}}() - - - -{{alias}}( length[, options] ) - Returns a one-dimensional single-precision floating-point ndarray having a - specified length. - - Parameters - ---------- - length: integer - 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.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A one-dimensional ndarray. - - Examples - -------- - > var arr = {{alias}}( 5 ) - - > var len = {{alias:@stdlib/ndarray/numel}}( arr ) - 5 - - -{{alias}}( obj[, options] ) - Creates a one-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. - - 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.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A one-dimensional ndarray. - - Examples - -------- - > var v = [ 1.0, 2.0, 3.0 ]; - > var arr = {{alias}}( v ) - - > var len = {{alias:@stdlib/ndarray/numel}}( arr ) - 3 - - -{{alias}}( buffer[, byteOffset[, length]][, options] ) - Returns a one-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. - - length: integer (optional) - View length. If not provided, the view spans from the byteOffset to - the end of the underlying ArrayBuffer. - - 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.readonly: boolean (optional) - Boolean indicating whether an array should be read-only. Default: false. - - Returns - ------- - out: ndarray - A one-dimensional ndarray. - - Examples - -------- - > var buf = new {{alias:@stdlib/array/buffer}}( 32 ); - > var arr = {{alias}}( buf, 0, 4 ) - - > var len = {{alias:@stdlib/ndarray/numel}}( arr ) - 4 - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index c222353..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,86 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 Float32Vector = require( './index' ); - - -// TESTS // - -// The function returns an ndarray... -{ - new Float32Vector(); // $ExpectType float32ndarray - new Float32Vector( {} ); // $ExpectType float32ndarray - - new Float32Vector( 10 ); // $ExpectType float32ndarray - new Float32Vector( 10, {} ); // $ExpectType float32ndarray - - new Float32Vector( [ 1, 2, 3 ] ); // $ExpectType float32ndarray - new Float32Vector( [ 1, 2, 3 ], {} ); // $ExpectType float32ndarray - - new Float32Vector( new ArrayBuffer( 10 ) ); // $ExpectType float32ndarray - new Float32Vector( new ArrayBuffer( 10 ), {} ); // $ExpectType float32ndarray - - new Float32Vector( new ArrayBuffer( 10 ), 8 ); // $ExpectType float32ndarray - new Float32Vector( new ArrayBuffer( 10 ), 8, {} ); // $ExpectType float32ndarray - - new Float32Vector( new ArrayBuffer( 10 ), 8, 0 ); // $ExpectType float32ndarray - new Float32Vector( new ArrayBuffer( 10 ), 8, 0, {} ); // $ExpectType float32ndarray - - const vector = Float32Vector; - vector(); // $ExpectType float32ndarray - vector( {} ); // $ExpectType float32ndarray - - vector( 10 ); // $ExpectType float32ndarray - vector( 10, {} ); // $ExpectType float32ndarray - - vector( [ 1, 2, 3 ] ); // $ExpectType float32ndarray - vector( [ 1, 2, 3 ], {} ); // $ExpectType float32ndarray - - vector( new ArrayBuffer( 10 ) ); // $ExpectType float32ndarray - vector( new ArrayBuffer( 10 ), {} ); // $ExpectType float32ndarray - - vector( new ArrayBuffer( 10 ), 8 ); // $ExpectType float32ndarray - vector( new ArrayBuffer( 10 ), 8, {} ); // $ExpectType float32ndarray - - vector( new ArrayBuffer( 10 ), 8, 0 ); // $ExpectType float32ndarray - vector( new ArrayBuffer( 10 ), 8, 0, {} ); // $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 Float32Vector( true ); // $ExpectError - new Float32Vector( false ); // $ExpectError - new Float32Vector( null ); // $ExpectError - new Float32Vector( ( x: number ): number => x ); // $ExpectError - - const vector = Float32Vector; - vector( true ); // $ExpectError - vector( false ); // $ExpectError - vector( null ); // $ExpectError - vector( ( 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 Float32Vector( buf, 8, 2, {}, {} ); // $ExpectError - - const vector = Float32Vector; - vector( buf, 8, 2, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 24af996..0000000 --- a/examples/index.js +++ /dev/null @@ -1,43 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 Float32Vector = require( './../lib' ); - -// Create a vector containing random values: -var x = new Float32Vector( discreteUniform( 10, 0, 100 ) ); - -// Compute the sum: -var v = sum( x ); -console.log( v.get() ); - -// 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: -v = sum( y ); -console.log( v.get() ); 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 346c235..fe7ae4c 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 } from '@stdlib/types/ndarray'; import { Collection, AccessorArrayLike } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..3221a3c --- /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-vector-ctor@v0.1.1-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..0e99e27 --- /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) 2025 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* 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-vector-ctor';\n\n\n// MAIN //\n\n/**\n* Returns a single-precision floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Float32Vector\n* @type {Function}\n* @param {(NonNegativeInteger|Collection|ArrayBuffer|Iterable)} [arg] - length, typed array, array-like object, buffer, or iterable\n* @param {NonNegativeInteger} [byteOffset=0] - byte offset\n* @param {NonNegativeInteger} [length] - view length\n* @param {Options} [options] - function options\n* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only vector\n* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed vector dimensions\n* @param {string} [options.order='row-major'] - memory layout (either row-major or column-major)\n* @throws {TypeError} first argument must be either a length, typed array, array-like object, buffer, iterable, or options object\n* @throws {TypeError} must provide valid options\n* @returns {ndarray} one-dimensional ndarray\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector();\n* // returns \n*\n* var len = numel( arr );\n* // returns 0\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector( 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n*\n* var arr = new Float32Vector( [ 1.0, 2.0 ] );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf );\n* // returns \n*\n* var len = numel( arr );\n* // returns 8\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 32 );\n* var arr = new Float32Vector( buf, 16 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 4\n*\n* @example\n* import numel from '@stdlib/ndarray-numel';\n* import ArrayBuffer from '@stdlib/array-buffer';\n*\n* var buf = new ArrayBuffer( 64 );\n* var arr = new Float32Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Float32Vector = factory( 'float32' );\n\n\n// EXPORTS //\n\nexport default Float32Vector;\n"],"names":["Float32Vector","factory"],"mappings":";;yGAuGG,IAACA,EAAgBC,EAAS"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 47c8cc7..0000000 --- a/lib/index.js +++ /dev/null @@ -1,100 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 vector (i.e., a one-dimensional ndarray). -* -* @module @stdlib/ndarray-vector-float32 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var v = new Float32Vector(); -* // returns -* -* var len = numel( v ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var v = new Float32Vector( 2 ); -* // returns -* -* var len = numel( v ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var v = new Float32Vector( [ 1.0, 2.0 ] ); -* // returns -* -* var len = numel( v ); -* // returns 2 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var buf = new ArrayBuffer( 32 ); -* var v = new Float32Vector( buf ); -* // returns -* -* var len = numel( v ); -* // returns 8 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var buf = new ArrayBuffer( 32 ); -* var v = new Float32Vector( buf, 16 ); -* // returns -* -* var len = numel( v ); -* // returns 4 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Float32Vector = require( '@stdlib/ndarray-vector-float32' ); -* -* var buf = new ArrayBuffer( 64 ); -* var v = new Float32Vector( buf, 16, 2 ); -* // returns -* -* var len = numel( v ); -* // returns 2 -*/ - -// 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 853738a..0000000 --- a/lib/main.js +++ /dev/null @@ -1,109 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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-vector-ctor' ).factory; - - -// MAIN // - -/** -* Returns a single-precision floating-point vector (i.e., a one-dimensional ndarray). -* -* @name Float32Vector -* @type {Function} -* @param {(NonNegativeInteger|Collection|ArrayBuffer|Iterable)} [arg] - length, typed array, array-like object, buffer, or iterable -* @param {NonNegativeInteger} [byteOffset=0] - byte offset -* @param {NonNegativeInteger} [length] - view length -* @param {Options} [options] - function options -* @param {boolean} [options.readonly=false] - boolean indicating whether to return a read-only vector -* @param {string} [options.mode='throw'] - specifies how to handle indices which exceed vector dimensions -* @param {string} [options.order='row-major'] - memory layout (either row-major or column-major) -* @throws {TypeError} first argument must be either a length, typed array, array-like object, buffer, iterable, or options object -* @throws {TypeError} must provide valid options -* @returns {ndarray} one-dimensional ndarray -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector(); -* // returns -* -* var len = numel( arr ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector( 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Float32Vector( [ 1.0, 2.0 ] ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 32 ); -* var arr = new Float32Vector( buf ); -* // returns -* -* var len = numel( arr ); -* // returns 8 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 32 ); -* var arr = new Float32Vector( buf, 16 ); -* // returns -* -* var len = numel( arr ); -* // returns 4 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 64 ); -* var arr = new Float32Vector( buf, 16, 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -*/ -var Float32Vector = factory( 'float32' ); - - -// EXPORTS // - -module.exports = Float32Vector; diff --git a/package.json b/package.json index c619204..9eed39e 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.1", "description": "Create a single-precision floating-point vector (i.e., a one-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-vector-ctor": "^0.1.1", - "@stdlib/types": "^0.4.3" - }, - "devDependencies": { - "@stdlib/array-buffer": "^0.2.3", - "@stdlib/array-float32": "^0.2.3", - "@stdlib/array-float64": "^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/buffer-from-array": "^0.2.3", - "@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-numel": "^0.2.3", - "@stdlib/ndarray-order": "^0.2.3", - "@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..f8585b0 --- /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 950f063..0000000 --- a/test/test.js +++ /dev/null @@ -1,1024 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2025 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 Float64Array = require( '@stdlib/array-float64' ); -var Float32Array = require( '@stdlib/array-float32' ); -var getData = require( '@stdlib/ndarray-data-buffer' ); -var array2buffer = require( '@stdlib/buffer-from-array' ); -var numel = require( '@stdlib/ndarray-numel' ); -var getOrder = require( '@stdlib/ndarray-order' ); -var Float32Vector = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof Float32Vector, '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, - function noop() {} - ]; - for ( i = 0; i < 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 Float32Vector( 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, - function noop() {} - ]; - for ( i = 0; i < 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 Float32Vector( value, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (byteoffset)', 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 Float32Vector( value, 0 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (byteoffset, 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 Float32Vector( value, 0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (byteoffset, length)', 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 Float32Vector( value, 0, 1 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first argument (byteoffset, length, 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 Float32Vector( value, 0, 1, {} ); - }; - } -}); - -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 Float32Vector( 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 Float32Vector( new ArrayBuffer( 8 ), value, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid byte offset argument (length)', 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 Float32Vector( new ArrayBuffer( 8 ), value, 1 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid byte offset argument (length, 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 Float32Vector( new ArrayBuffer( 8 ), value, 1, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid length 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 Float32Vector( new ArrayBuffer( 8 ), 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid length 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 Float32Vector( new ArrayBuffer( 8 ), 0, value, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (length)', 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 Float32Vector( 10, 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 Float32Vector( [], 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 Float32Vector( 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 Float32Vector( new ArrayBuffer( 8 ), 0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (arraybuffer, byteoffset, length)', 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 Float32Vector( new ArrayBuffer( 8 ), 0, 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 Float32Vector({ - '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 Float32Vector({ - 'mode': 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 Float32Vector({ - 'readonly': value - }); - }; - } -}); - -tape( 'the function returns a one-dimensional ndarray', function test( t ) { - var arr; - - arr = new Float32Vector(); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 0, 'returns expected value' ); - - arr = new Float32Vector( {} ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 0, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (length)', function test( t ) { - var arr; - - arr = new Float32Vector( 10 ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 10, 'returns expected value' ); - - arr = new Float32Vector( 10, {} ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 10, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (array)', function test( t ) { - var arr; - var out; - - arr = [ 1.0, 2.0, 3.0, 4.0 ]; - - out = new Float32Vector( arr ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - out = new Float32Vector( arr, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (typed array)', function test( t ) { - var arr; - var out; - - arr = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] ); - - out = new Float32Vector( arr ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - out = new Float32Vector( arr, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (buffer)', function test( t ) { - var arr; - var out; - var buf; - - arr = [ 1, 2, 3, 4 ]; - buf = array2buffer( arr ); - - out = new Float32Vector( buf ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - out = new Float32Vector( buf, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 4, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( arr ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (arraybuffer)', function test( t ) { - var buf; - var out; - - buf = new ArrayBuffer( 8 ); - - out = new Float32Vector( buf ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 2, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf ) ), true, 'returns expected value' ); - - out = new Float32Vector( buf, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 2, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (arraybuffer, byteoffset)', function test( t ) { - var buf; - var out; - - buf = new ArrayBuffer( 32 ); - - out = new Float32Vector( buf, 8 ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 6, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf, 8 ) ), true, 'returns expected value' ); - - out = new Float32Vector( buf, 8, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 6, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf, 8 ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns a one-dimensional ndarray (arraybuffer, byteoffset, length)', function test( t ) { - var buf; - var out; - - buf = new ArrayBuffer( 32 ); - - out = new Float32Vector( buf, 8, 2 ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 2, 'returns expected value' ); - t.strictEqual( isSameFloat32Array( getData( out ), new Float32Array( buf, 8, 2 ) ), true, 'returns expected value' ); - - out = new Float32Vector( buf, 8, 2, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 2, '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 Float32Vector({ - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 0, 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Float32Vector({ - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 0, 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (length)', function test( t ) { - var arr; - - arr = new Float32Vector( 10, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 10, 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Float32Vector( 10, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 10, '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 Float32Vector( [ 1.0, 2.0, 3.0, 4.0 ], { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 4, 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Float32Vector( [ 1.0, 2.0, 3.0, 4.0 ], { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 4, '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 Float32Vector( new ArrayBuffer( 32 ), { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 8, 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Float32Vector( new ArrayBuffer( 32 ), { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 8, '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 Float32Vector( new ArrayBuffer( 32 ), 8, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 6, 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 6, 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'column-major', 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout (arraybuffer, byteoffset, length)', function test( t ) { - var arr; - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, 2, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 2, 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, 2, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 2, '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 Float32Vector({ - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 0, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning read-only ndarrays (length)', function test( t ) { - var arr; - - arr = new Float32Vector( 10, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 10, '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 Float32Vector( [ 1.0, 2.0, 3.0, 4.0 ], { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 4, '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 Float32Vector( new ArrayBuffer( 32 ), { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 8, '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 Float32Vector( new ArrayBuffer( 32 ), 8, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 6, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning read-only ndarrays (arraybuffer, byteoffset, length)', function test( t ) { - var arr; - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, 2, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 2, '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 Float32Vector({ - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 0, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning writable ndarrays (length)', function test( t ) { - var arr; - - arr = new Float32Vector( 10, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 10, '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 Float32Vector( [ 1.0, 2.0, 3.0, 4.0 ], { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 4, '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 Float32Vector( new ArrayBuffer( 32 ), { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 8, '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 Float32Vector( new ArrayBuffer( 32 ), 8, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 6, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports returning writable ndarrays (arraybuffer, byteoffset, length)', function test( t ) { - var arr; - - arr = new Float32Vector( new ArrayBuffer( 32 ), 8, 2, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'float32' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 2, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -});