From 52d583b1aa12ede3e2f9dad2feceeb07311b352e Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 31 Jan 2026 06:43:35 +0000 Subject: [PATCH 01/37] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index a36e134..2d357a6 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", @@ -94,4 +95,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 2034379c5761c3a8b3471b3544e7d9e7558c490a Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 31 Jan 2026 07:42:23 +0000 Subject: [PATCH 02/37] 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 | 50 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 61 +- 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 | 49 - 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 | 71 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 1022 ---- 44 files changed, 4877 insertions(+), 5332 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 53d0027..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/complex128) 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 eb573d9..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/complex128) 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 f060126..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: '43 19 * * 2' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 83d50c4..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,821 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send notification to Zulip if job fails: - - name: 'Send notification to Zulip in case of failure' - # Pin action to full length commit SHA - uses: zulip/github-actions-zulip/send-message@e4c8f27c732ba9bd98ac6be0583096dea82feea5 # v1.0.2 - if: failure() - with: - api-key: ${{ secrets.ZULIP_API_KEY }} - email: 'github-actions-bot@stdlib.zulipchat.com' - organization-url: 'https://stdlib.zulipchat.com' - to: 'workflows-standalone' - type: 'stream' - topic: ${{ github.event.repository.name }} - content: | - :cross_mark: **${{ github.workflow }}** workflow failed - - **Repository:** [${{ github.repository }}](${{ github.server_url }}/${{ github.repository }}) - **Run:** [View workflow run](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}) - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -231,7 +222,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]. @@ -294,9 +285,9 @@ Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-vector-complex128/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 be3b5e9..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 Complex128Vector = require( './../lib' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var arr; - var i; - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr = new Complex128Vector( 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 cad7cce..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 Complex128Vector = 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 Complex128Vector( 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 ec929f5..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/complex128" -%% click B href "https://github.com/stdlib-js/ndarray-vector-complex128/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-vector-complex128/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-vector-complex128/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-vector-complex128/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-vector-complex128/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/vector/complex128 -[production-url]: https://github.com/stdlib-js/ndarray-vector-complex128/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-vector-complex128/tree/deno -[deno-readme]: https://github.com/stdlib-js/ndarray-vector-complex128/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/ndarray-vector-complex128/tree/umd -[umd-readme]: https://github.com/stdlib-js/ndarray-vector-complex128/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/ndarray-vector-complex128/tree/esm -[esm-readme]: https://github.com/stdlib-js/ndarray-vector-complex128/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 063d577..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var a=function(o,r){return function(){return r||o((r={exports:{}}).exports,r),r.exports}};var t=a(function(u,e){ -var c=require('@stdlib/ndarray-vector-ctor/dist').factory,s=c("complex128");e.exports=s -});var i=t();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 bb0a8c7..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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Complex128Vector\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 Complex128Vector();\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 Complex128Vector( 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.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( 64 );\n* var arr = new Complex128Vector( buf );\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( 48 );\n* var arr = new Complex128Vector( buf, 16 );\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( 64 );\n* var arr = new Complex128Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Complex128Vector = factory( 'complex128' );\n\n\n// EXPORTS //\n\nmodule.exports = Complex128Vector;\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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @module @stdlib/ndarray-vector-complex128\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var v = new Complex128Vector();\n* // returns \n*\n* var len = numel( v );\n* // returns 0\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var v = new Complex128Vector( 2 );\n* // returns \n*\n* var len = numel( v );\n* // returns 2\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var v = new Complex128Vector( [ 1.0, 2.0, 3.0, 4.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 Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var buf = new ArrayBuffer( 64 );\n* var v = new Complex128Vector( buf );\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 Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var buf = new ArrayBuffer( 48 );\n* var v = new Complex128Vector( buf, 16 );\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 Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var buf = new ArrayBuffer( 64 );\n* var v = new Complex128Vector( 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,EAAmBD,EAAS,YAAa,EAK7CD,EAAO,QAAUE,ICdjB,IAAIC,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "factory", "Complex128Vector", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 718f62a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,175 +0,0 @@ - -{{alias}}( [options] ) - Returns a one-dimensional double-precision complex 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 double-precision complex 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 double-precision complex 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, 4.0, 5.0, 6.0 ]; - > var arr = {{alias}}( v ) - - > var len = {{alias:@stdlib/ndarray/numel}}( arr ) - 3 - - -{{alias}}( buffer[, byteOffset[, length]][, options] ) - Returns a one-dimensional double-precision complex 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}}( 64 ); - > var arr = {{alias}}( buf, 0, 2 ) - - > var len = {{alias:@stdlib/ndarray/numel}}( arr ) - 2 - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 79a3121..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 Complex128Vector = require( './index' ); - - -// TESTS // - -// The function returns an ndarray... -{ - new Complex128Vector(); // $ExpectType complex128ndarray - new Complex128Vector( {} ); // $ExpectType complex128ndarray - - new Complex128Vector( 10 ); // $ExpectType complex128ndarray - new Complex128Vector( 10, {} ); // $ExpectType complex128ndarray - - new Complex128Vector( [ 1, 2, 3, 4 ] ); // $ExpectType complex128ndarray - new Complex128Vector( [ 1, 2, 3, 4 ], {} ); // $ExpectType complex128ndarray - - new Complex128Vector( new ArrayBuffer( 10 ) ); // $ExpectType complex128ndarray - new Complex128Vector( new ArrayBuffer( 10 ), {} ); // $ExpectType complex128ndarray - - new Complex128Vector( new ArrayBuffer( 10 ), 8 ); // $ExpectType complex128ndarray - new Complex128Vector( new ArrayBuffer( 10 ), 8, {} ); // $ExpectType complex128ndarray - - new Complex128Vector( new ArrayBuffer( 10 ), 8, 0 ); // $ExpectType complex128ndarray - new Complex128Vector( new ArrayBuffer( 10 ), 8, 0, {} ); // $ExpectType complex128ndarray - - const vector = Complex128Vector; - vector(); // $ExpectType complex128ndarray - vector( {} ); // $ExpectType complex128ndarray - - vector( 10 ); // $ExpectType complex128ndarray - vector( 10, {} ); // $ExpectType complex128ndarray - - vector( [ 1, 2, 3, 4 ] ); // $ExpectType complex128ndarray - vector( [ 1, 2, 3, 4 ], {} ); // $ExpectType complex128ndarray - - vector( new ArrayBuffer( 10 ) ); // $ExpectType complex128ndarray - vector( new ArrayBuffer( 10 ), {} ); // $ExpectType complex128ndarray - - vector( new ArrayBuffer( 10 ), 8 ); // $ExpectType complex128ndarray - vector( new ArrayBuffer( 10 ), 8, {} ); // $ExpectType complex128ndarray - - vector( new ArrayBuffer( 10 ), 8, 0 ); // $ExpectType complex128ndarray - vector( new ArrayBuffer( 10 ), 8, 0, {} ); // $ExpectType complex128ndarray -} - -// 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 Complex128Vector( true ); // $ExpectError - new Complex128Vector( false ); // $ExpectError - new Complex128Vector( null ); // $ExpectError - new Complex128Vector( ( x: number ): number => x ); // $ExpectError - - const vector = Complex128Vector; - 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 Complex128Vector( buf, 8, 2, {}, {} ); // $ExpectError - - const vector = Complex128Vector; - vector( buf, 8, 2, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 0cc3779..0000000 --- a/examples/index.js +++ /dev/null @@ -1,49 +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 real = require( '@stdlib/complex-float64-real' ); -var imag = require( '@stdlib/complex-float64-imag' ); -var Complex128 = require( '@stdlib/complex-float64-ctor' ); -var Complex128Vector = require( './../lib' ); - -// Create a vector containing random values: -var x = new Complex128Vector( discreteUniform( 20, 0, 100 ) ); - -// Compute the sum: -var v = sum( x ); -console.log( v.get() ); - -// Define a function which applies a threshold to real and imaginary components: -function threshold( v ) { - if ( real( v ) > 10 && imag( v ) > 10 ) { - return v; - } - return new Complex128( 0.0, 0.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 deda8c2..5a1608e 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -20,7 +20,7 @@ /* eslint-disable @typescript-eslint/unified-signatures */ -/// +/// import { Order, Mode, complex128ndarray } 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..87c9fcb --- /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 r}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-vector-ctor@esm/index.mjs";var t=r("complex128");export{t as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..192354c --- /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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Complex128Vector\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 Complex128Vector();\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 Complex128Vector( 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.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( 64 );\n* var arr = new Complex128Vector( buf );\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( 48 );\n* var arr = new Complex128Vector( buf, 16 );\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( 64 );\n* var arr = new Complex128Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Complex128Vector = factory( 'complex128' );\n\n\n// EXPORTS //\n\nexport default Complex128Vector;\n"],"names":["Complex128Vector","factory"],"mappings":";;kGAuGG,IAACA,EAAmBC,EAAS"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 872d251..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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray). -* -* @module @stdlib/ndarray-vector-complex128 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var v = new Complex128Vector(); -* // returns -* -* var len = numel( v ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var v = new Complex128Vector( 2 ); -* // returns -* -* var len = numel( v ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var v = new Complex128Vector( [ 1.0, 2.0, 3.0, 4.0 ] ); -* // returns -* -* var len = numel( v ); -* // returns 2 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var buf = new ArrayBuffer( 64 ); -* var v = new Complex128Vector( buf ); -* // returns -* -* var len = numel( v ); -* // returns 4 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var buf = new ArrayBuffer( 48 ); -* var v = new Complex128Vector( buf, 16 ); -* // returns -* -* var len = numel( v ); -* // returns 2 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var buf = new ArrayBuffer( 64 ); -* var v = new Complex128Vector( 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 e9fb219..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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray). -* -* @name Complex128Vector -* @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 Complex128Vector(); -* // returns -* -* var len = numel( arr ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Complex128Vector( 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Complex128Vector( [ 1.0, 2.0, 3.0, 4.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( 64 ); -* var arr = new Complex128Vector( buf ); -* // returns -* -* var len = numel( arr ); -* // returns 4 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 48 ); -* var arr = new Complex128Vector( buf, 16 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 64 ); -* var arr = new Complex128Vector( buf, 16, 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -*/ -var Complex128Vector = factory( 'complex128' ); - - -// EXPORTS // - -module.exports = Complex128Vector; diff --git a/package.json b/package.json index 2d357a6..91f8b07 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.0", "description": "Create a double-precision complex 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,48 +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-complex128": "^0.3.1", - "@stdlib/array-float32": "^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-complex128array": "^0.2.2", - "@stdlib/blas-ext-sum": "github:stdlib-js/blas-ext-sum#main", - "@stdlib/buffer-from-array": "^0.2.2", - "@stdlib/complex-float64-ctor": "^0.1.0", - "@stdlib/complex-float64-imag": "^0.1.1", - "@stdlib/complex-float64-real": "^0.1.1", - "@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", @@ -95,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..e2c07c8 --- /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 06badd2..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 isSameComplex128Array = require( '@stdlib/assert-is-same-complex128array' ); -var isReadOnly = require( '@stdlib/ndarray-base-assert-is-read-only' ); -var ArrayBuffer = require( '@stdlib/array-buffer' ); -var Float32Array = require( '@stdlib/array-float32' ); -var Complex128Array = require( '@stdlib/array-complex128' ); -var getData = require( '@stdlib/ndarray-data-buffer' ); -var array2buffer = require( '@stdlib/buffer-from-array' ); -var Complex128Vector = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof Complex128Vector, '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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( [], 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector({ - '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 Complex128Vector({ - '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 Complex128Vector({ - 'readonly': value - }); - }; - } -}); - -tape( 'the function returns a one-dimensional ndarray', function test( t ) { - var arr; - - arr = new Complex128Vector(); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - - arr = new Complex128Vector( {} ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( 10 ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, 'returns expected value' ); - - arr = new Complex128Vector( 10, {} ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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, 5.0, 6.0, 7.0, 8.0 ]; - - out = new Complex128Vector( arr ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( arr ) ), true, 'returns expected value' ); - - out = new Complex128Vector( arr, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( 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 Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - - out = new Complex128Vector( arr ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( arr ) ), true, 'returns expected value' ); - - out = new Complex128Vector( arr, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( 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, 5, 6, 7, 8 ]; - buf = array2buffer( arr ); - - out = new Complex128Vector( buf ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( arr ) ), true, 'returns expected value' ); - - out = new Complex128Vector( buf, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( 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( 32 ); - - out = new Complex128Vector( buf ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 2, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( buf ) ), true, 'returns expected value' ); - - out = new Complex128Vector( buf, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 2, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( 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( 64 ); - - out = new Complex128Vector( buf, 16 ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 3, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( buf, 16 ) ), true, 'returns expected value' ); - - out = new Complex128Vector( buf, 16, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 3, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( buf, 16 ) ), 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( 64 ); - - out = new Complex128Vector( buf, 16, 2 ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 2, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( buf, 16, 2 ) ), true, 'returns expected value' ); - - out = new Complex128Vector( buf, 16, 2, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 2, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( buf, 16, 2 ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout', function test( t ) { - var arr; - - arr = new Complex128Vector({ - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Complex128Vector({ - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( 10, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Complex128Vector( 10, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ], { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 4, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Complex128Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ], { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( new ArrayBuffer( 64 ), { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 4, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Complex128Vector( new ArrayBuffer( 64 ), { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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, byteoffset)', function test( t ) { - var arr; - - arr = new Complex128Vector( new ArrayBuffer( 64 ), 16, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 3, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Complex128Vector( new ArrayBuffer( 64 ), 16, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 3, '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 Complex128Vector( new ArrayBuffer( 64 ), 16, 2, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 2, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Complex128Vector( new ArrayBuffer( 64 ), 16, 2, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector({ - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( 10, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ], { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( new ArrayBuffer( 64 ), { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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, byteoffset)', function test( t ) { - var arr; - - arr = new Complex128Vector( new ArrayBuffer( 64 ), 16, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 3, '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 Complex128Vector( new ArrayBuffer( 64 ), 16, 2, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector({ - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( 10, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ], { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( new ArrayBuffer( 64 ), { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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, byteoffset)', function test( t ) { - var arr; - - arr = new Complex128Vector( new ArrayBuffer( 64 ), 16, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 3, '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 Complex128Vector( new ArrayBuffer( 64 ), 16, 2, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 2, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); From e7214b046a536eda2b04782f48a3f116ce802d1f Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 2 Feb 2026 03:15:53 +0000 Subject: [PATCH 03/37] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 5bcad95..366c315 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.2" }, "devDependencies": { "@stdlib/array-buffer": "^0.2.2", @@ -94,4 +95,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 0b21e21261ba906ef852c247d863e72b1aaa8aa9 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 2 Feb 2026 04:24:33 +0000 Subject: [PATCH 04/37] 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 5a1608e..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, complex128ndarray } 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 Complex128Vector { - /** - * Creates a double-precision complex 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 Complex128Vector(); - * // returns - * - * var len = numel( arr ); - * // returns 0 - */ - new ( options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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 Complex128Vector( 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( length: number, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.0 ] ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( obj: Collection | AccessorArrayLike | Iterable, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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 Complex128Vector( buf ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( buffer: ArrayBuffer, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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( 64 ); - * var arr = new Complex128Vector( buf, 16 ); - * // returns - * - * var len = numel( arr ); - * // returns 3 - */ - new ( buffer: ArrayBuffer, byteOffset: number, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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( 64 ); - * var arr = new Complex128Vector( buf, 16, 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( buffer: ArrayBuffer, byteOffset: number, length: number, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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 Complex128Vector(); - * // returns - * - * var len = numel( arr ); - * // returns 0 - */ - ( options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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 Complex128Vector( 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( length: number, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.0 ] ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( obj: Collection | AccessorArrayLike | Iterable, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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( 64 ); - * var arr = new Complex128Vector( buf ); - * // returns - * - * var len = numel( arr ); - * // returns 4 - */ - ( buffer: ArrayBuffer, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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( 64 ); - * var arr = new Complex128Vector( buf, 16 ); - * // returns - * - * var len = numel( arr ); - * // returns 3 - */ - ( buffer: ArrayBuffer, byteOffset: number, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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( 64 ); - * var arr = new Complex128Vector( buf, 16, 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( buffer: ArrayBuffer, byteOffset: number, length: number, options?: Options ): complex128ndarray; -} - -/** -* Creates a double-precision complex 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 Complex128Vector(); -* // returns -* -* var len = numel( arr ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Complex128Vector( 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Complex128Vector( [ 1.0, 2.0, 3.0, 4.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( 64 ); -* var arr = new Complex128Vector( buf, 16, 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -*/ -declare var ctor: Complex128Vector; - - -// EXPORTS // - -export = ctor; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 87c9fcb..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 r}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-vector-ctor@esm/index.mjs";var t=r("complex128");export{t as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 192354c..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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Complex128Vector\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 Complex128Vector();\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 Complex128Vector( 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.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( 64 );\n* var arr = new Complex128Vector( buf );\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( 48 );\n* var arr = new Complex128Vector( buf, 16 );\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( 64 );\n* var arr = new Complex128Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Complex128Vector = factory( 'complex128' );\n\n\n// EXPORTS //\n\nexport default Complex128Vector;\n"],"names":["Complex128Vector","factory"],"mappings":";;kGAuGG,IAACA,EAAmBC,EAAS"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index e2c07c8..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 22a3659f31e954e78282a0d50616a29ce183f3b0 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 2 Feb 2026 04:25:15 +0000 Subject: [PATCH 05/37] 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 | 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 | 50 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 61 +- 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 | 49 - 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 | 71 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 1022 ---- 45 files changed, 4877 insertions(+), 5333 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 381da67..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2026-02-02T02:39:27.905Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 53d0027..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/complex128) 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 eb573d9..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/complex128) 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 f060126..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: '43 19 * * 2' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 83d50c4..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,821 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send notification to Zulip if job fails: - - name: 'Send notification to Zulip in case of failure' - # Pin action to full length commit SHA - uses: zulip/github-actions-zulip/send-message@e4c8f27c732ba9bd98ac6be0583096dea82feea5 # v1.0.2 - if: failure() - with: - api-key: ${{ secrets.ZULIP_API_KEY }} - email: 'github-actions-bot@stdlib.zulipchat.com' - organization-url: 'https://stdlib.zulipchat.com' - to: 'workflows-standalone' - type: 'stream' - topic: ${{ github.event.repository.name }} - content: | - :cross_mark: **${{ github.workflow }}** workflow failed - - **Repository:** [${{ github.repository }}](${{ github.server_url }}/${{ github.repository }}) - **Run:** [View workflow run](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}) - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -231,7 +222,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]. @@ -294,9 +285,9 @@ Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-vector-complex128/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 be3b5e9..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 Complex128Vector = require( './../lib' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var arr; - var i; - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr = new Complex128Vector( 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 cad7cce..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 Complex128Vector = 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 Complex128Vector( 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 ec929f5..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/complex128" -%% click B href "https://github.com/stdlib-js/ndarray-vector-complex128/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-vector-complex128/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-vector-complex128/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-vector-complex128/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-vector-complex128/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/vector/complex128 -[production-url]: https://github.com/stdlib-js/ndarray-vector-complex128/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-vector-complex128/tree/deno -[deno-readme]: https://github.com/stdlib-js/ndarray-vector-complex128/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/ndarray-vector-complex128/tree/umd -[umd-readme]: https://github.com/stdlib-js/ndarray-vector-complex128/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/ndarray-vector-complex128/tree/esm -[esm-readme]: https://github.com/stdlib-js/ndarray-vector-complex128/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 063d577..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var a=function(o,r){return function(){return r||o((r={exports:{}}).exports,r),r.exports}};var t=a(function(u,e){ -var c=require('@stdlib/ndarray-vector-ctor/dist').factory,s=c("complex128");e.exports=s -});var i=t();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 bb0a8c7..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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Complex128Vector\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 Complex128Vector();\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 Complex128Vector( 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.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( 64 );\n* var arr = new Complex128Vector( buf );\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( 48 );\n* var arr = new Complex128Vector( buf, 16 );\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( 64 );\n* var arr = new Complex128Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Complex128Vector = factory( 'complex128' );\n\n\n// EXPORTS //\n\nmodule.exports = Complex128Vector;\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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @module @stdlib/ndarray-vector-complex128\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var v = new Complex128Vector();\n* // returns \n*\n* var len = numel( v );\n* // returns 0\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var v = new Complex128Vector( 2 );\n* // returns \n*\n* var len = numel( v );\n* // returns 2\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var v = new Complex128Vector( [ 1.0, 2.0, 3.0, 4.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 Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var buf = new ArrayBuffer( 64 );\n* var v = new Complex128Vector( buf );\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 Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var buf = new ArrayBuffer( 48 );\n* var v = new Complex128Vector( buf, 16 );\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 Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var buf = new ArrayBuffer( 64 );\n* var v = new Complex128Vector( 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,EAAmBD,EAAS,YAAa,EAK7CD,EAAO,QAAUE,ICdjB,IAAIC,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "factory", "Complex128Vector", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 718f62a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,175 +0,0 @@ - -{{alias}}( [options] ) - Returns a one-dimensional double-precision complex 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 double-precision complex 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 double-precision complex 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, 4.0, 5.0, 6.0 ]; - > var arr = {{alias}}( v ) - - > var len = {{alias:@stdlib/ndarray/numel}}( arr ) - 3 - - -{{alias}}( buffer[, byteOffset[, length]][, options] ) - Returns a one-dimensional double-precision complex 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}}( 64 ); - > var arr = {{alias}}( buf, 0, 2 ) - - > var len = {{alias:@stdlib/ndarray/numel}}( arr ) - 2 - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 79a3121..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 Complex128Vector = require( './index' ); - - -// TESTS // - -// The function returns an ndarray... -{ - new Complex128Vector(); // $ExpectType complex128ndarray - new Complex128Vector( {} ); // $ExpectType complex128ndarray - - new Complex128Vector( 10 ); // $ExpectType complex128ndarray - new Complex128Vector( 10, {} ); // $ExpectType complex128ndarray - - new Complex128Vector( [ 1, 2, 3, 4 ] ); // $ExpectType complex128ndarray - new Complex128Vector( [ 1, 2, 3, 4 ], {} ); // $ExpectType complex128ndarray - - new Complex128Vector( new ArrayBuffer( 10 ) ); // $ExpectType complex128ndarray - new Complex128Vector( new ArrayBuffer( 10 ), {} ); // $ExpectType complex128ndarray - - new Complex128Vector( new ArrayBuffer( 10 ), 8 ); // $ExpectType complex128ndarray - new Complex128Vector( new ArrayBuffer( 10 ), 8, {} ); // $ExpectType complex128ndarray - - new Complex128Vector( new ArrayBuffer( 10 ), 8, 0 ); // $ExpectType complex128ndarray - new Complex128Vector( new ArrayBuffer( 10 ), 8, 0, {} ); // $ExpectType complex128ndarray - - const vector = Complex128Vector; - vector(); // $ExpectType complex128ndarray - vector( {} ); // $ExpectType complex128ndarray - - vector( 10 ); // $ExpectType complex128ndarray - vector( 10, {} ); // $ExpectType complex128ndarray - - vector( [ 1, 2, 3, 4 ] ); // $ExpectType complex128ndarray - vector( [ 1, 2, 3, 4 ], {} ); // $ExpectType complex128ndarray - - vector( new ArrayBuffer( 10 ) ); // $ExpectType complex128ndarray - vector( new ArrayBuffer( 10 ), {} ); // $ExpectType complex128ndarray - - vector( new ArrayBuffer( 10 ), 8 ); // $ExpectType complex128ndarray - vector( new ArrayBuffer( 10 ), 8, {} ); // $ExpectType complex128ndarray - - vector( new ArrayBuffer( 10 ), 8, 0 ); // $ExpectType complex128ndarray - vector( new ArrayBuffer( 10 ), 8, 0, {} ); // $ExpectType complex128ndarray -} - -// 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 Complex128Vector( true ); // $ExpectError - new Complex128Vector( false ); // $ExpectError - new Complex128Vector( null ); // $ExpectError - new Complex128Vector( ( x: number ): number => x ); // $ExpectError - - const vector = Complex128Vector; - 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 Complex128Vector( buf, 8, 2, {}, {} ); // $ExpectError - - const vector = Complex128Vector; - vector( buf, 8, 2, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 0cc3779..0000000 --- a/examples/index.js +++ /dev/null @@ -1,49 +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 real = require( '@stdlib/complex-float64-real' ); -var imag = require( '@stdlib/complex-float64-imag' ); -var Complex128 = require( '@stdlib/complex-float64-ctor' ); -var Complex128Vector = require( './../lib' ); - -// Create a vector containing random values: -var x = new Complex128Vector( discreteUniform( 20, 0, 100 ) ); - -// Compute the sum: -var v = sum( x ); -console.log( v.get() ); - -// Define a function which applies a threshold to real and imaginary components: -function threshold( v ) { - if ( real( v ) > 10 && imag( v ) > 10 ) { - return v; - } - return new Complex128( 0.0, 0.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 deda8c2..5a1608e 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -20,7 +20,7 @@ /* eslint-disable @typescript-eslint/unified-signatures */ -/// +/// import { Order, Mode, complex128ndarray } 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..f5e2106 --- /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 r}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-vector-ctor@v0.1.0-esm/index.mjs";var t=r("complex128");export{t as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..fc76095 --- /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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Complex128Vector\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 Complex128Vector();\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 Complex128Vector( 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.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( 64 );\n* var arr = new Complex128Vector( buf );\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( 48 );\n* var arr = new Complex128Vector( buf, 16 );\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( 64 );\n* var arr = new Complex128Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Complex128Vector = factory( 'complex128' );\n\n\n// EXPORTS //\n\nexport default Complex128Vector;\n"],"names":["Complex128Vector","factory"],"mappings":";;yGAuGG,IAACA,EAAmBC,EAAS"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 872d251..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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray). -* -* @module @stdlib/ndarray-vector-complex128 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var v = new Complex128Vector(); -* // returns -* -* var len = numel( v ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var v = new Complex128Vector( 2 ); -* // returns -* -* var len = numel( v ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var v = new Complex128Vector( [ 1.0, 2.0, 3.0, 4.0 ] ); -* // returns -* -* var len = numel( v ); -* // returns 2 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var buf = new ArrayBuffer( 64 ); -* var v = new Complex128Vector( buf ); -* // returns -* -* var len = numel( v ); -* // returns 4 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var buf = new ArrayBuffer( 48 ); -* var v = new Complex128Vector( buf, 16 ); -* // returns -* -* var len = numel( v ); -* // returns 2 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var buf = new ArrayBuffer( 64 ); -* var v = new Complex128Vector( 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 e9fb219..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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray). -* -* @name Complex128Vector -* @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 Complex128Vector(); -* // returns -* -* var len = numel( arr ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Complex128Vector( 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Complex128Vector( [ 1.0, 2.0, 3.0, 4.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( 64 ); -* var arr = new Complex128Vector( buf ); -* // returns -* -* var len = numel( arr ); -* // returns 4 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 48 ); -* var arr = new Complex128Vector( buf, 16 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 64 ); -* var arr = new Complex128Vector( buf, 16, 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -*/ -var Complex128Vector = factory( 'complex128' ); - - -// EXPORTS // - -module.exports = Complex128Vector; diff --git a/package.json b/package.json index 366c315..91f8b07 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.0", "description": "Create a double-precision complex 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,48 +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.2" - }, - "devDependencies": { - "@stdlib/array-buffer": "^0.2.2", - "@stdlib/array-complex128": "^0.3.1", - "@stdlib/array-float32": "^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-complex128array": "^0.2.2", - "@stdlib/blas-ext-sum": "^0.1.0", - "@stdlib/buffer-from-array": "^0.2.2", - "@stdlib/complex-float64-ctor": "^0.1.1", - "@stdlib/complex-float64-imag": "^0.1.1", - "@stdlib/complex-float64-real": "^0.1.1", - "@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", @@ -95,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..a34fd8f --- /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 06badd2..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 isSameComplex128Array = require( '@stdlib/assert-is-same-complex128array' ); -var isReadOnly = require( '@stdlib/ndarray-base-assert-is-read-only' ); -var ArrayBuffer = require( '@stdlib/array-buffer' ); -var Float32Array = require( '@stdlib/array-float32' ); -var Complex128Array = require( '@stdlib/array-complex128' ); -var getData = require( '@stdlib/ndarray-data-buffer' ); -var array2buffer = require( '@stdlib/buffer-from-array' ); -var Complex128Vector = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof Complex128Vector, '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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( [], 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector({ - '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 Complex128Vector({ - '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 Complex128Vector({ - 'readonly': value - }); - }; - } -}); - -tape( 'the function returns a one-dimensional ndarray', function test( t ) { - var arr; - - arr = new Complex128Vector(); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - - arr = new Complex128Vector( {} ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( 10 ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, 'returns expected value' ); - - arr = new Complex128Vector( 10, {} ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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, 5.0, 6.0, 7.0, 8.0 ]; - - out = new Complex128Vector( arr ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( arr ) ), true, 'returns expected value' ); - - out = new Complex128Vector( arr, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( 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 Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - - out = new Complex128Vector( arr ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( arr ) ), true, 'returns expected value' ); - - out = new Complex128Vector( arr, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( 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, 5, 6, 7, 8 ]; - buf = array2buffer( arr ); - - out = new Complex128Vector( buf ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( arr ) ), true, 'returns expected value' ); - - out = new Complex128Vector( buf, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( 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( 32 ); - - out = new Complex128Vector( buf ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 2, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( buf ) ), true, 'returns expected value' ); - - out = new Complex128Vector( buf, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 2, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( 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( 64 ); - - out = new Complex128Vector( buf, 16 ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 3, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( buf, 16 ) ), true, 'returns expected value' ); - - out = new Complex128Vector( buf, 16, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 3, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( buf, 16 ) ), 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( 64 ); - - out = new Complex128Vector( buf, 16, 2 ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 2, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( buf, 16, 2 ) ), true, 'returns expected value' ); - - out = new Complex128Vector( buf, 16, 2, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 2, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( buf, 16, 2 ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout', function test( t ) { - var arr; - - arr = new Complex128Vector({ - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Complex128Vector({ - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( 10, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Complex128Vector( 10, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ], { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 4, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Complex128Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ], { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( new ArrayBuffer( 64 ), { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 4, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Complex128Vector( new ArrayBuffer( 64 ), { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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, byteoffset)', function test( t ) { - var arr; - - arr = new Complex128Vector( new ArrayBuffer( 64 ), 16, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 3, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Complex128Vector( new ArrayBuffer( 64 ), 16, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 3, '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 Complex128Vector( new ArrayBuffer( 64 ), 16, 2, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 2, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Complex128Vector( new ArrayBuffer( 64 ), 16, 2, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector({ - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( 10, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ], { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( new ArrayBuffer( 64 ), { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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, byteoffset)', function test( t ) { - var arr; - - arr = new Complex128Vector( new ArrayBuffer( 64 ), 16, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 3, '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 Complex128Vector( new ArrayBuffer( 64 ), 16, 2, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector({ - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( 10, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ], { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( new ArrayBuffer( 64 ), { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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, byteoffset)', function test( t ) { - var arr; - - arr = new Complex128Vector( new ArrayBuffer( 64 ), 16, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 3, '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 Complex128Vector( new ArrayBuffer( 64 ), 16, 2, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 2, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); From d8b061ccfb9c44d0014450e1f901c7df82b2ade4 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 8 Feb 2026 23:15:47 +0000 Subject: [PATCH 06/37] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 22262fd..75245f7 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", @@ -94,4 +95,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 1457fb21f0bcb9b7e5cda81a8c001935c60a8222 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 9 Feb 2026 00:05:20 +0000 Subject: [PATCH 07/37] 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 5a1608e..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, complex128ndarray } 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 Complex128Vector { - /** - * Creates a double-precision complex 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 Complex128Vector(); - * // returns - * - * var len = numel( arr ); - * // returns 0 - */ - new ( options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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 Complex128Vector( 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( length: number, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.0 ] ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( obj: Collection | AccessorArrayLike | Iterable, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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 Complex128Vector( buf ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( buffer: ArrayBuffer, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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( 64 ); - * var arr = new Complex128Vector( buf, 16 ); - * // returns - * - * var len = numel( arr ); - * // returns 3 - */ - new ( buffer: ArrayBuffer, byteOffset: number, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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( 64 ); - * var arr = new Complex128Vector( buf, 16, 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( buffer: ArrayBuffer, byteOffset: number, length: number, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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 Complex128Vector(); - * // returns - * - * var len = numel( arr ); - * // returns 0 - */ - ( options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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 Complex128Vector( 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( length: number, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.0 ] ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( obj: Collection | AccessorArrayLike | Iterable, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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( 64 ); - * var arr = new Complex128Vector( buf ); - * // returns - * - * var len = numel( arr ); - * // returns 4 - */ - ( buffer: ArrayBuffer, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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( 64 ); - * var arr = new Complex128Vector( buf, 16 ); - * // returns - * - * var len = numel( arr ); - * // returns 3 - */ - ( buffer: ArrayBuffer, byteOffset: number, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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( 64 ); - * var arr = new Complex128Vector( buf, 16, 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( buffer: ArrayBuffer, byteOffset: number, length: number, options?: Options ): complex128ndarray; -} - -/** -* Creates a double-precision complex 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 Complex128Vector(); -* // returns -* -* var len = numel( arr ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Complex128Vector( 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Complex128Vector( [ 1.0, 2.0, 3.0, 4.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( 64 ); -* var arr = new Complex128Vector( buf, 16, 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -*/ -declare var ctor: Complex128Vector; - - -// EXPORTS // - -export = ctor; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index f5e2106..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 r}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-vector-ctor@v0.1.0-esm/index.mjs";var t=r("complex128");export{t as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index fc76095..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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Complex128Vector\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 Complex128Vector();\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 Complex128Vector( 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.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( 64 );\n* var arr = new Complex128Vector( buf );\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( 48 );\n* var arr = new Complex128Vector( buf, 16 );\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( 64 );\n* var arr = new Complex128Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Complex128Vector = factory( 'complex128' );\n\n\n// EXPORTS //\n\nexport default Complex128Vector;\n"],"names":["Complex128Vector","factory"],"mappings":";;yGAuGG,IAACA,EAAmBC,EAAS"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index a34fd8f..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From c11732ad10d1ebfeec46488fc0c728d35a8851d9 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 9 Feb 2026 00:05:48 +0000 Subject: [PATCH 08/37] 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 | 50 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 61 +- 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 | 49 - 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 | 71 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 1022 ---- 44 files changed, 4877 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 53d0027..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/complex128) 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 eb573d9..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/complex128) 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 f060126..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: '43 19 * * 2' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 83d50c4..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,821 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send notification to Zulip if job fails: - - name: 'Send notification to Zulip in case of failure' - # Pin action to full length commit SHA - uses: zulip/github-actions-zulip/send-message@e4c8f27c732ba9bd98ac6be0583096dea82feea5 # v1.0.2 - if: failure() - with: - api-key: ${{ secrets.ZULIP_API_KEY }} - email: 'github-actions-bot@stdlib.zulipchat.com' - organization-url: 'https://stdlib.zulipchat.com' - to: 'workflows-standalone' - type: 'stream' - topic: ${{ github.event.repository.name }} - content: | - :cross_mark: **${{ github.workflow }}** workflow failed - - **Repository:** [${{ github.repository }}](${{ github.server_url }}/${{ github.repository }}) - **Run:** [View workflow run](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}) - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -231,7 +222,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]. @@ -294,9 +285,9 @@ Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-vector-complex128/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 be3b5e9..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 Complex128Vector = require( './../lib' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var arr; - var i; - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr = new Complex128Vector( 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 cad7cce..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 Complex128Vector = 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 Complex128Vector( 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 ec929f5..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/complex128" -%% click B href "https://github.com/stdlib-js/ndarray-vector-complex128/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-vector-complex128/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-vector-complex128/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-vector-complex128/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-vector-complex128/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/vector/complex128 -[production-url]: https://github.com/stdlib-js/ndarray-vector-complex128/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-vector-complex128/tree/deno -[deno-readme]: https://github.com/stdlib-js/ndarray-vector-complex128/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/ndarray-vector-complex128/tree/umd -[umd-readme]: https://github.com/stdlib-js/ndarray-vector-complex128/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/ndarray-vector-complex128/tree/esm -[esm-readme]: https://github.com/stdlib-js/ndarray-vector-complex128/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 063d577..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var a=function(o,r){return function(){return r||o((r={exports:{}}).exports,r),r.exports}};var t=a(function(u,e){ -var c=require('@stdlib/ndarray-vector-ctor/dist').factory,s=c("complex128");e.exports=s -});var i=t();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 bb0a8c7..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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Complex128Vector\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 Complex128Vector();\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 Complex128Vector( 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.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( 64 );\n* var arr = new Complex128Vector( buf );\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( 48 );\n* var arr = new Complex128Vector( buf, 16 );\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( 64 );\n* var arr = new Complex128Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Complex128Vector = factory( 'complex128' );\n\n\n// EXPORTS //\n\nmodule.exports = Complex128Vector;\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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @module @stdlib/ndarray-vector-complex128\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var v = new Complex128Vector();\n* // returns \n*\n* var len = numel( v );\n* // returns 0\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var v = new Complex128Vector( 2 );\n* // returns \n*\n* var len = numel( v );\n* // returns 2\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var v = new Complex128Vector( [ 1.0, 2.0, 3.0, 4.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 Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var buf = new ArrayBuffer( 64 );\n* var v = new Complex128Vector( buf );\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 Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var buf = new ArrayBuffer( 48 );\n* var v = new Complex128Vector( buf, 16 );\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 Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var buf = new ArrayBuffer( 64 );\n* var v = new Complex128Vector( 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,EAAmBD,EAAS,YAAa,EAK7CD,EAAO,QAAUE,ICdjB,IAAIC,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "factory", "Complex128Vector", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 718f62a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,175 +0,0 @@ - -{{alias}}( [options] ) - Returns a one-dimensional double-precision complex 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 double-precision complex 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 double-precision complex 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, 4.0, 5.0, 6.0 ]; - > var arr = {{alias}}( v ) - - > var len = {{alias:@stdlib/ndarray/numel}}( arr ) - 3 - - -{{alias}}( buffer[, byteOffset[, length]][, options] ) - Returns a one-dimensional double-precision complex 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}}( 64 ); - > var arr = {{alias}}( buf, 0, 2 ) - - > var len = {{alias:@stdlib/ndarray/numel}}( arr ) - 2 - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 79a3121..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 Complex128Vector = require( './index' ); - - -// TESTS // - -// The function returns an ndarray... -{ - new Complex128Vector(); // $ExpectType complex128ndarray - new Complex128Vector( {} ); // $ExpectType complex128ndarray - - new Complex128Vector( 10 ); // $ExpectType complex128ndarray - new Complex128Vector( 10, {} ); // $ExpectType complex128ndarray - - new Complex128Vector( [ 1, 2, 3, 4 ] ); // $ExpectType complex128ndarray - new Complex128Vector( [ 1, 2, 3, 4 ], {} ); // $ExpectType complex128ndarray - - new Complex128Vector( new ArrayBuffer( 10 ) ); // $ExpectType complex128ndarray - new Complex128Vector( new ArrayBuffer( 10 ), {} ); // $ExpectType complex128ndarray - - new Complex128Vector( new ArrayBuffer( 10 ), 8 ); // $ExpectType complex128ndarray - new Complex128Vector( new ArrayBuffer( 10 ), 8, {} ); // $ExpectType complex128ndarray - - new Complex128Vector( new ArrayBuffer( 10 ), 8, 0 ); // $ExpectType complex128ndarray - new Complex128Vector( new ArrayBuffer( 10 ), 8, 0, {} ); // $ExpectType complex128ndarray - - const vector = Complex128Vector; - vector(); // $ExpectType complex128ndarray - vector( {} ); // $ExpectType complex128ndarray - - vector( 10 ); // $ExpectType complex128ndarray - vector( 10, {} ); // $ExpectType complex128ndarray - - vector( [ 1, 2, 3, 4 ] ); // $ExpectType complex128ndarray - vector( [ 1, 2, 3, 4 ], {} ); // $ExpectType complex128ndarray - - vector( new ArrayBuffer( 10 ) ); // $ExpectType complex128ndarray - vector( new ArrayBuffer( 10 ), {} ); // $ExpectType complex128ndarray - - vector( new ArrayBuffer( 10 ), 8 ); // $ExpectType complex128ndarray - vector( new ArrayBuffer( 10 ), 8, {} ); // $ExpectType complex128ndarray - - vector( new ArrayBuffer( 10 ), 8, 0 ); // $ExpectType complex128ndarray - vector( new ArrayBuffer( 10 ), 8, 0, {} ); // $ExpectType complex128ndarray -} - -// 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 Complex128Vector( true ); // $ExpectError - new Complex128Vector( false ); // $ExpectError - new Complex128Vector( null ); // $ExpectError - new Complex128Vector( ( x: number ): number => x ); // $ExpectError - - const vector = Complex128Vector; - 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 Complex128Vector( buf, 8, 2, {}, {} ); // $ExpectError - - const vector = Complex128Vector; - vector( buf, 8, 2, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 0cc3779..0000000 --- a/examples/index.js +++ /dev/null @@ -1,49 +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 real = require( '@stdlib/complex-float64-real' ); -var imag = require( '@stdlib/complex-float64-imag' ); -var Complex128 = require( '@stdlib/complex-float64-ctor' ); -var Complex128Vector = require( './../lib' ); - -// Create a vector containing random values: -var x = new Complex128Vector( discreteUniform( 20, 0, 100 ) ); - -// Compute the sum: -var v = sum( x ); -console.log( v.get() ); - -// Define a function which applies a threshold to real and imaginary components: -function threshold( v ) { - if ( real( v ) > 10 && imag( v ) > 10 ) { - return v; - } - return new Complex128( 0.0, 0.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 deda8c2..5a1608e 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -20,7 +20,7 @@ /* eslint-disable @typescript-eslint/unified-signatures */ -/// +/// import { Order, Mode, complex128ndarray } 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..f5e2106 --- /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 r}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-vector-ctor@v0.1.0-esm/index.mjs";var t=r("complex128");export{t as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..fc76095 --- /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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Complex128Vector\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 Complex128Vector();\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 Complex128Vector( 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.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( 64 );\n* var arr = new Complex128Vector( buf );\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( 48 );\n* var arr = new Complex128Vector( buf, 16 );\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( 64 );\n* var arr = new Complex128Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Complex128Vector = factory( 'complex128' );\n\n\n// EXPORTS //\n\nexport default Complex128Vector;\n"],"names":["Complex128Vector","factory"],"mappings":";;yGAuGG,IAACA,EAAmBC,EAAS"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 872d251..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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray). -* -* @module @stdlib/ndarray-vector-complex128 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var v = new Complex128Vector(); -* // returns -* -* var len = numel( v ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var v = new Complex128Vector( 2 ); -* // returns -* -* var len = numel( v ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var v = new Complex128Vector( [ 1.0, 2.0, 3.0, 4.0 ] ); -* // returns -* -* var len = numel( v ); -* // returns 2 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var buf = new ArrayBuffer( 64 ); -* var v = new Complex128Vector( buf ); -* // returns -* -* var len = numel( v ); -* // returns 4 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var buf = new ArrayBuffer( 48 ); -* var v = new Complex128Vector( buf, 16 ); -* // returns -* -* var len = numel( v ); -* // returns 2 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var buf = new ArrayBuffer( 64 ); -* var v = new Complex128Vector( 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 e9fb219..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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray). -* -* @name Complex128Vector -* @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 Complex128Vector(); -* // returns -* -* var len = numel( arr ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Complex128Vector( 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Complex128Vector( [ 1.0, 2.0, 3.0, 4.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( 64 ); -* var arr = new Complex128Vector( buf ); -* // returns -* -* var len = numel( arr ); -* // returns 4 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 48 ); -* var arr = new Complex128Vector( buf, 16 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 64 ); -* var arr = new Complex128Vector( buf, 16, 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -*/ -var Complex128Vector = factory( 'complex128' ); - - -// EXPORTS // - -module.exports = Complex128Vector; diff --git a/package.json b/package.json index 75245f7..ebe5dcf 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.1", "description": "Create a double-precision complex 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,48 +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-complex128": "^0.3.2", - "@stdlib/array-float32": "^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-complex128array": "^0.2.2", - "@stdlib/blas-ext-sum": "^0.1.0", - "@stdlib/buffer-from-array": "^0.2.3", - "@stdlib/complex-float64-ctor": "^0.1.2", - "@stdlib/complex-float64-imag": "^0.1.2", - "@stdlib/complex-float64-real": "^0.1.2", - "@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", @@ -95,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..a34fd8f --- /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 06badd2..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 isSameComplex128Array = require( '@stdlib/assert-is-same-complex128array' ); -var isReadOnly = require( '@stdlib/ndarray-base-assert-is-read-only' ); -var ArrayBuffer = require( '@stdlib/array-buffer' ); -var Float32Array = require( '@stdlib/array-float32' ); -var Complex128Array = require( '@stdlib/array-complex128' ); -var getData = require( '@stdlib/ndarray-data-buffer' ); -var array2buffer = require( '@stdlib/buffer-from-array' ); -var Complex128Vector = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof Complex128Vector, '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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( [], 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector({ - '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 Complex128Vector({ - '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 Complex128Vector({ - 'readonly': value - }); - }; - } -}); - -tape( 'the function returns a one-dimensional ndarray', function test( t ) { - var arr; - - arr = new Complex128Vector(); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - - arr = new Complex128Vector( {} ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( 10 ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, 'returns expected value' ); - - arr = new Complex128Vector( 10, {} ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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, 5.0, 6.0, 7.0, 8.0 ]; - - out = new Complex128Vector( arr ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( arr ) ), true, 'returns expected value' ); - - out = new Complex128Vector( arr, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( 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 Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - - out = new Complex128Vector( arr ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( arr ) ), true, 'returns expected value' ); - - out = new Complex128Vector( arr, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( 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, 5, 6, 7, 8 ]; - buf = array2buffer( arr ); - - out = new Complex128Vector( buf ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( arr ) ), true, 'returns expected value' ); - - out = new Complex128Vector( buf, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( 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( 32 ); - - out = new Complex128Vector( buf ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 2, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( buf ) ), true, 'returns expected value' ); - - out = new Complex128Vector( buf, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 2, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( 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( 64 ); - - out = new Complex128Vector( buf, 16 ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 3, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( buf, 16 ) ), true, 'returns expected value' ); - - out = new Complex128Vector( buf, 16, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 3, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( buf, 16 ) ), 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( 64 ); - - out = new Complex128Vector( buf, 16, 2 ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 2, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( buf, 16, 2 ) ), true, 'returns expected value' ); - - out = new Complex128Vector( buf, 16, 2, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 2, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( buf, 16, 2 ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout', function test( t ) { - var arr; - - arr = new Complex128Vector({ - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Complex128Vector({ - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( 10, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Complex128Vector( 10, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ], { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 4, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Complex128Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ], { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( new ArrayBuffer( 64 ), { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 4, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Complex128Vector( new ArrayBuffer( 64 ), { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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, byteoffset)', function test( t ) { - var arr; - - arr = new Complex128Vector( new ArrayBuffer( 64 ), 16, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 3, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Complex128Vector( new ArrayBuffer( 64 ), 16, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 3, '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 Complex128Vector( new ArrayBuffer( 64 ), 16, 2, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 2, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Complex128Vector( new ArrayBuffer( 64 ), 16, 2, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector({ - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( 10, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ], { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( new ArrayBuffer( 64 ), { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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, byteoffset)', function test( t ) { - var arr; - - arr = new Complex128Vector( new ArrayBuffer( 64 ), 16, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 3, '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 Complex128Vector( new ArrayBuffer( 64 ), 16, 2, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector({ - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( 10, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ], { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( new ArrayBuffer( 64 ), { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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, byteoffset)', function test( t ) { - var arr; - - arr = new Complex128Vector( new ArrayBuffer( 64 ), 16, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 3, '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 Complex128Vector( new ArrayBuffer( 64 ), 16, 2, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 2, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); From 42cabd66c5250d88d6295cc7d68503f6fa7ea319 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 9 Feb 2026 00:36:35 +0000 Subject: [PATCH 09/37] 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 df4904d..454381b 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,7 @@ limitations under the License. ## Usage ```javascript -import Complex128Vector from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-vector-complex128@esm/index.mjs'; +import Complex128Vector from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-vector-complex128@v0.1.1-esm/index.mjs'; ``` #### Complex128Vector( \[options] ) @@ -164,7 +164,7 @@ import map from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-map@esm/index.mjs import real from 'https://cdn.jsdelivr.net/gh/stdlib-js/complex-float64-real@esm/index.mjs'; import imag from 'https://cdn.jsdelivr.net/gh/stdlib-js/complex-float64-imag@esm/index.mjs'; import Complex128 from 'https://cdn.jsdelivr.net/gh/stdlib-js/complex-float64-ctor@esm/index.mjs'; -import Complex128Vector from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-vector-complex128@esm/index.mjs'; +import Complex128Vector from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-vector-complex128@v0.1.1-esm/index.mjs'; // Create a vector containing random values: var x = new Complex128Vector( discreteUniform( 20, 0, 100 ) ); From b8632a8857ff3a4197cc769a6d411b13c1b96005 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 9 Feb 2026 00:36:36 +0000 Subject: [PATCH 10/37] Auto-generated commit --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 454381b..fd24388 100644 --- a/README.md +++ b/README.md @@ -51,6 +51,11 @@ limitations under the License. ## Usage +```javascript +import Complex128Vector from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-vector-complex128@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-complex128/tags). For example, + ```javascript import Complex128Vector from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-vector-complex128@v0.1.1-esm/index.mjs'; ``` @@ -164,7 +169,7 @@ import map from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-map@esm/index.mjs import real from 'https://cdn.jsdelivr.net/gh/stdlib-js/complex-float64-real@esm/index.mjs'; import imag from 'https://cdn.jsdelivr.net/gh/stdlib-js/complex-float64-imag@esm/index.mjs'; import Complex128 from 'https://cdn.jsdelivr.net/gh/stdlib-js/complex-float64-ctor@esm/index.mjs'; -import Complex128Vector from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-vector-complex128@v0.1.1-esm/index.mjs'; +import Complex128Vector from 'https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-vector-complex128@esm/index.mjs'; // Create a vector containing random values: var x = new Complex128Vector( discreteUniform( 20, 0, 100 ) ); From b45aa8a8560e4ef6de854466ca20c8b4331f63a6 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 2 Mar 2026 03:00:29 +0000 Subject: [PATCH 11/37] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index b4963ea..007f288 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", @@ -94,4 +95,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 3584b361c15bd1bb1c3069dce0225481fd3abf0e Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 2 Mar 2026 05:03:13 +0000 Subject: [PATCH 12/37] 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 5a1608e..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, complex128ndarray } 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 Complex128Vector { - /** - * Creates a double-precision complex 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 Complex128Vector(); - * // returns - * - * var len = numel( arr ); - * // returns 0 - */ - new ( options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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 Complex128Vector( 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( length: number, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.0 ] ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( obj: Collection | AccessorArrayLike | Iterable, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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 Complex128Vector( buf ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( buffer: ArrayBuffer, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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( 64 ); - * var arr = new Complex128Vector( buf, 16 ); - * // returns - * - * var len = numel( arr ); - * // returns 3 - */ - new ( buffer: ArrayBuffer, byteOffset: number, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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( 64 ); - * var arr = new Complex128Vector( buf, 16, 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( buffer: ArrayBuffer, byteOffset: number, length: number, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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 Complex128Vector(); - * // returns - * - * var len = numel( arr ); - * // returns 0 - */ - ( options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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 Complex128Vector( 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( length: number, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.0 ] ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( obj: Collection | AccessorArrayLike | Iterable, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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( 64 ); - * var arr = new Complex128Vector( buf ); - * // returns - * - * var len = numel( arr ); - * // returns 4 - */ - ( buffer: ArrayBuffer, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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( 64 ); - * var arr = new Complex128Vector( buf, 16 ); - * // returns - * - * var len = numel( arr ); - * // returns 3 - */ - ( buffer: ArrayBuffer, byteOffset: number, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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( 64 ); - * var arr = new Complex128Vector( buf, 16, 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( buffer: ArrayBuffer, byteOffset: number, length: number, options?: Options ): complex128ndarray; -} - -/** -* Creates a double-precision complex 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 Complex128Vector(); -* // returns -* -* var len = numel( arr ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Complex128Vector( 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Complex128Vector( [ 1.0, 2.0, 3.0, 4.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( 64 ); -* var arr = new Complex128Vector( buf, 16, 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -*/ -declare var ctor: Complex128Vector; - - -// EXPORTS // - -export = ctor; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index f5e2106..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 r}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-vector-ctor@v0.1.0-esm/index.mjs";var t=r("complex128");export{t as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index fc76095..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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Complex128Vector\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 Complex128Vector();\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 Complex128Vector( 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.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( 64 );\n* var arr = new Complex128Vector( buf );\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( 48 );\n* var arr = new Complex128Vector( buf, 16 );\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( 64 );\n* var arr = new Complex128Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Complex128Vector = factory( 'complex128' );\n\n\n// EXPORTS //\n\nexport default Complex128Vector;\n"],"names":["Complex128Vector","factory"],"mappings":";;yGAuGG,IAACA,EAAmBC,EAAS"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index a34fd8f..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From b1dcd1a2e8cc88474041b6186da6b949e83fff4a Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 2 Mar 2026 05:03:56 +0000 Subject: [PATCH 13/37] 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 | 50 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 61 +- 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 | 49 - 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 | 71 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 1022 ---- 45 files changed, 4877 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 44fa218..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2026-03-02T02:12:21.324Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 53d0027..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/complex128) 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 eb573d9..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/complex128) 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 f060126..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: '43 19 * * 2' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 83d50c4..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,821 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send notification to Zulip if job fails: - - name: 'Send notification to Zulip in case of failure' - # Pin action to full length commit SHA - uses: zulip/github-actions-zulip/send-message@e4c8f27c732ba9bd98ac6be0583096dea82feea5 # v1.0.2 - if: failure() - with: - api-key: ${{ secrets.ZULIP_API_KEY }} - email: 'github-actions-bot@stdlib.zulipchat.com' - organization-url: 'https://stdlib.zulipchat.com' - to: 'workflows-standalone' - type: 'stream' - topic: ${{ github.event.repository.name }} - content: | - :cross_mark: **${{ github.workflow }}** workflow failed - - **Repository:** [${{ github.repository }}](${{ github.server_url }}/${{ github.repository }}) - **Run:** [View workflow run](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}) - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -231,7 +222,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]. @@ -294,9 +285,9 @@ Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-vector-complex128/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 be3b5e9..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 Complex128Vector = require( './../lib' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var arr; - var i; - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr = new Complex128Vector( 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 cad7cce..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 Complex128Vector = 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 Complex128Vector( 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 ec929f5..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/complex128" -%% click B href "https://github.com/stdlib-js/ndarray-vector-complex128/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-vector-complex128/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-vector-complex128/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-vector-complex128/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-vector-complex128/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/vector/complex128 -[production-url]: https://github.com/stdlib-js/ndarray-vector-complex128/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-vector-complex128/tree/deno -[deno-readme]: https://github.com/stdlib-js/ndarray-vector-complex128/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/ndarray-vector-complex128/tree/umd -[umd-readme]: https://github.com/stdlib-js/ndarray-vector-complex128/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/ndarray-vector-complex128/tree/esm -[esm-readme]: https://github.com/stdlib-js/ndarray-vector-complex128/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 063d577..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var a=function(o,r){return function(){return r||o((r={exports:{}}).exports,r),r.exports}};var t=a(function(u,e){ -var c=require('@stdlib/ndarray-vector-ctor/dist').factory,s=c("complex128");e.exports=s -});var i=t();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 bb0a8c7..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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Complex128Vector\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 Complex128Vector();\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 Complex128Vector( 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.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( 64 );\n* var arr = new Complex128Vector( buf );\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( 48 );\n* var arr = new Complex128Vector( buf, 16 );\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( 64 );\n* var arr = new Complex128Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Complex128Vector = factory( 'complex128' );\n\n\n// EXPORTS //\n\nmodule.exports = Complex128Vector;\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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @module @stdlib/ndarray-vector-complex128\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var v = new Complex128Vector();\n* // returns \n*\n* var len = numel( v );\n* // returns 0\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var v = new Complex128Vector( 2 );\n* // returns \n*\n* var len = numel( v );\n* // returns 2\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var v = new Complex128Vector( [ 1.0, 2.0, 3.0, 4.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 Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var buf = new ArrayBuffer( 64 );\n* var v = new Complex128Vector( buf );\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 Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var buf = new ArrayBuffer( 48 );\n* var v = new Complex128Vector( buf, 16 );\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 Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var buf = new ArrayBuffer( 64 );\n* var v = new Complex128Vector( 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,EAAmBD,EAAS,YAAa,EAK7CD,EAAO,QAAUE,ICdjB,IAAIC,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "factory", "Complex128Vector", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 718f62a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,175 +0,0 @@ - -{{alias}}( [options] ) - Returns a one-dimensional double-precision complex 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 double-precision complex 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 double-precision complex 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, 4.0, 5.0, 6.0 ]; - > var arr = {{alias}}( v ) - - > var len = {{alias:@stdlib/ndarray/numel}}( arr ) - 3 - - -{{alias}}( buffer[, byteOffset[, length]][, options] ) - Returns a one-dimensional double-precision complex 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}}( 64 ); - > var arr = {{alias}}( buf, 0, 2 ) - - > var len = {{alias:@stdlib/ndarray/numel}}( arr ) - 2 - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 79a3121..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 Complex128Vector = require( './index' ); - - -// TESTS // - -// The function returns an ndarray... -{ - new Complex128Vector(); // $ExpectType complex128ndarray - new Complex128Vector( {} ); // $ExpectType complex128ndarray - - new Complex128Vector( 10 ); // $ExpectType complex128ndarray - new Complex128Vector( 10, {} ); // $ExpectType complex128ndarray - - new Complex128Vector( [ 1, 2, 3, 4 ] ); // $ExpectType complex128ndarray - new Complex128Vector( [ 1, 2, 3, 4 ], {} ); // $ExpectType complex128ndarray - - new Complex128Vector( new ArrayBuffer( 10 ) ); // $ExpectType complex128ndarray - new Complex128Vector( new ArrayBuffer( 10 ), {} ); // $ExpectType complex128ndarray - - new Complex128Vector( new ArrayBuffer( 10 ), 8 ); // $ExpectType complex128ndarray - new Complex128Vector( new ArrayBuffer( 10 ), 8, {} ); // $ExpectType complex128ndarray - - new Complex128Vector( new ArrayBuffer( 10 ), 8, 0 ); // $ExpectType complex128ndarray - new Complex128Vector( new ArrayBuffer( 10 ), 8, 0, {} ); // $ExpectType complex128ndarray - - const vector = Complex128Vector; - vector(); // $ExpectType complex128ndarray - vector( {} ); // $ExpectType complex128ndarray - - vector( 10 ); // $ExpectType complex128ndarray - vector( 10, {} ); // $ExpectType complex128ndarray - - vector( [ 1, 2, 3, 4 ] ); // $ExpectType complex128ndarray - vector( [ 1, 2, 3, 4 ], {} ); // $ExpectType complex128ndarray - - vector( new ArrayBuffer( 10 ) ); // $ExpectType complex128ndarray - vector( new ArrayBuffer( 10 ), {} ); // $ExpectType complex128ndarray - - vector( new ArrayBuffer( 10 ), 8 ); // $ExpectType complex128ndarray - vector( new ArrayBuffer( 10 ), 8, {} ); // $ExpectType complex128ndarray - - vector( new ArrayBuffer( 10 ), 8, 0 ); // $ExpectType complex128ndarray - vector( new ArrayBuffer( 10 ), 8, 0, {} ); // $ExpectType complex128ndarray -} - -// 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 Complex128Vector( true ); // $ExpectError - new Complex128Vector( false ); // $ExpectError - new Complex128Vector( null ); // $ExpectError - new Complex128Vector( ( x: number ): number => x ); // $ExpectError - - const vector = Complex128Vector; - 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 Complex128Vector( buf, 8, 2, {}, {} ); // $ExpectError - - const vector = Complex128Vector; - vector( buf, 8, 2, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 0cc3779..0000000 --- a/examples/index.js +++ /dev/null @@ -1,49 +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 real = require( '@stdlib/complex-float64-real' ); -var imag = require( '@stdlib/complex-float64-imag' ); -var Complex128 = require( '@stdlib/complex-float64-ctor' ); -var Complex128Vector = require( './../lib' ); - -// Create a vector containing random values: -var x = new Complex128Vector( discreteUniform( 20, 0, 100 ) ); - -// Compute the sum: -var v = sum( x ); -console.log( v.get() ); - -// Define a function which applies a threshold to real and imaginary components: -function threshold( v ) { - if ( real( v ) > 10 && imag( v ) > 10 ) { - return v; - } - return new Complex128( 0.0, 0.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 deda8c2..5a1608e 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -20,7 +20,7 @@ /* eslint-disable @typescript-eslint/unified-signatures */ -/// +/// import { Order, Mode, complex128ndarray } 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..8400946 --- /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 r}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-vector-ctor@v0.1.1-esm/index.mjs";var t=r("complex128");export{t as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..fc76095 --- /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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Complex128Vector\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 Complex128Vector();\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 Complex128Vector( 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.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( 64 );\n* var arr = new Complex128Vector( buf );\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( 48 );\n* var arr = new Complex128Vector( buf, 16 );\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( 64 );\n* var arr = new Complex128Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Complex128Vector = factory( 'complex128' );\n\n\n// EXPORTS //\n\nexport default Complex128Vector;\n"],"names":["Complex128Vector","factory"],"mappings":";;yGAuGG,IAACA,EAAmBC,EAAS"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 872d251..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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray). -* -* @module @stdlib/ndarray-vector-complex128 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var v = new Complex128Vector(); -* // returns -* -* var len = numel( v ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var v = new Complex128Vector( 2 ); -* // returns -* -* var len = numel( v ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var v = new Complex128Vector( [ 1.0, 2.0, 3.0, 4.0 ] ); -* // returns -* -* var len = numel( v ); -* // returns 2 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var buf = new ArrayBuffer( 64 ); -* var v = new Complex128Vector( buf ); -* // returns -* -* var len = numel( v ); -* // returns 4 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var buf = new ArrayBuffer( 48 ); -* var v = new Complex128Vector( buf, 16 ); -* // returns -* -* var len = numel( v ); -* // returns 2 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var buf = new ArrayBuffer( 64 ); -* var v = new Complex128Vector( 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 e9fb219..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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray). -* -* @name Complex128Vector -* @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 Complex128Vector(); -* // returns -* -* var len = numel( arr ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Complex128Vector( 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Complex128Vector( [ 1.0, 2.0, 3.0, 4.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( 64 ); -* var arr = new Complex128Vector( buf ); -* // returns -* -* var len = numel( arr ); -* // returns 4 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 48 ); -* var arr = new Complex128Vector( buf, 16 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 64 ); -* var arr = new Complex128Vector( buf, 16, 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -*/ -var Complex128Vector = factory( 'complex128' ); - - -// EXPORTS // - -module.exports = Complex128Vector; diff --git a/package.json b/package.json index 007f288..ebe5dcf 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.1", "description": "Create a double-precision complex 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,48 +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-complex128": "^0.3.2", - "@stdlib/array-float32": "^0.2.3", - "@stdlib/assert-is-ndarray-like": "^0.2.3", - "@stdlib/assert-is-ndarray-like-with-data-type": "^0.1.1", - "@stdlib/assert-is-same-complex128array": "^0.2.3", - "@stdlib/blas-ext-sum": "^0.1.1", - "@stdlib/buffer-from-array": "^0.2.3", - "@stdlib/complex-float64-ctor": "^0.1.2", - "@stdlib/complex-float64-imag": "^0.1.2", - "@stdlib/complex-float64-real": "^0.1.2", - "@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", @@ -95,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..e10f927 --- /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 06badd2..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 isSameComplex128Array = require( '@stdlib/assert-is-same-complex128array' ); -var isReadOnly = require( '@stdlib/ndarray-base-assert-is-read-only' ); -var ArrayBuffer = require( '@stdlib/array-buffer' ); -var Float32Array = require( '@stdlib/array-float32' ); -var Complex128Array = require( '@stdlib/array-complex128' ); -var getData = require( '@stdlib/ndarray-data-buffer' ); -var array2buffer = require( '@stdlib/buffer-from-array' ); -var Complex128Vector = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof Complex128Vector, '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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( [], 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector({ - '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 Complex128Vector({ - '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 Complex128Vector({ - 'readonly': value - }); - }; - } -}); - -tape( 'the function returns a one-dimensional ndarray', function test( t ) { - var arr; - - arr = new Complex128Vector(); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - - arr = new Complex128Vector( {} ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( 10 ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, 'returns expected value' ); - - arr = new Complex128Vector( 10, {} ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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, 5.0, 6.0, 7.0, 8.0 ]; - - out = new Complex128Vector( arr ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( arr ) ), true, 'returns expected value' ); - - out = new Complex128Vector( arr, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( 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 Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - - out = new Complex128Vector( arr ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( arr ) ), true, 'returns expected value' ); - - out = new Complex128Vector( arr, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( 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, 5, 6, 7, 8 ]; - buf = array2buffer( arr ); - - out = new Complex128Vector( buf ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( arr ) ), true, 'returns expected value' ); - - out = new Complex128Vector( buf, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( 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( 32 ); - - out = new Complex128Vector( buf ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 2, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( buf ) ), true, 'returns expected value' ); - - out = new Complex128Vector( buf, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 2, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( 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( 64 ); - - out = new Complex128Vector( buf, 16 ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 3, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( buf, 16 ) ), true, 'returns expected value' ); - - out = new Complex128Vector( buf, 16, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 3, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( buf, 16 ) ), 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( 64 ); - - out = new Complex128Vector( buf, 16, 2 ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 2, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( buf, 16, 2 ) ), true, 'returns expected value' ); - - out = new Complex128Vector( buf, 16, 2, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 2, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( buf, 16, 2 ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout', function test( t ) { - var arr; - - arr = new Complex128Vector({ - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Complex128Vector({ - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( 10, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Complex128Vector( 10, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ], { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 4, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Complex128Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ], { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( new ArrayBuffer( 64 ), { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 4, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Complex128Vector( new ArrayBuffer( 64 ), { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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, byteoffset)', function test( t ) { - var arr; - - arr = new Complex128Vector( new ArrayBuffer( 64 ), 16, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 3, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Complex128Vector( new ArrayBuffer( 64 ), 16, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 3, '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 Complex128Vector( new ArrayBuffer( 64 ), 16, 2, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 2, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Complex128Vector( new ArrayBuffer( 64 ), 16, 2, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector({ - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( 10, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ], { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( new ArrayBuffer( 64 ), { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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, byteoffset)', function test( t ) { - var arr; - - arr = new Complex128Vector( new ArrayBuffer( 64 ), 16, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 3, '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 Complex128Vector( new ArrayBuffer( 64 ), 16, 2, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector({ - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( 10, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ], { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( new ArrayBuffer( 64 ), { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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, byteoffset)', function test( t ) { - var arr; - - arr = new Complex128Vector( new ArrayBuffer( 64 ), 16, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 3, '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 Complex128Vector( new ArrayBuffer( 64 ), 16, 2, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 2, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); From 59ac4fa92d04c6792e76db42ba8fb616e3750349 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 10 Apr 2026 03:19:33 +0000 Subject: [PATCH 14/37] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index b4963ea..007f288 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", @@ -94,4 +95,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From c4c8bc5a7753d6951aecf0845ae99b5556a71638 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 10 Apr 2026 03:24:41 +0000 Subject: [PATCH 15/37] 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 5a1608e..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, complex128ndarray } 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 Complex128Vector { - /** - * Creates a double-precision complex 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 Complex128Vector(); - * // returns - * - * var len = numel( arr ); - * // returns 0 - */ - new ( options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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 Complex128Vector( 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( length: number, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.0 ] ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( obj: Collection | AccessorArrayLike | Iterable, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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 Complex128Vector( buf ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( buffer: ArrayBuffer, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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( 64 ); - * var arr = new Complex128Vector( buf, 16 ); - * // returns - * - * var len = numel( arr ); - * // returns 3 - */ - new ( buffer: ArrayBuffer, byteOffset: number, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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( 64 ); - * var arr = new Complex128Vector( buf, 16, 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( buffer: ArrayBuffer, byteOffset: number, length: number, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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 Complex128Vector(); - * // returns - * - * var len = numel( arr ); - * // returns 0 - */ - ( options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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 Complex128Vector( 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( length: number, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.0 ] ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( obj: Collection | AccessorArrayLike | Iterable, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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( 64 ); - * var arr = new Complex128Vector( buf ); - * // returns - * - * var len = numel( arr ); - * // returns 4 - */ - ( buffer: ArrayBuffer, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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( 64 ); - * var arr = new Complex128Vector( buf, 16 ); - * // returns - * - * var len = numel( arr ); - * // returns 3 - */ - ( buffer: ArrayBuffer, byteOffset: number, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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( 64 ); - * var arr = new Complex128Vector( buf, 16, 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( buffer: ArrayBuffer, byteOffset: number, length: number, options?: Options ): complex128ndarray; -} - -/** -* Creates a double-precision complex 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 Complex128Vector(); -* // returns -* -* var len = numel( arr ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Complex128Vector( 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Complex128Vector( [ 1.0, 2.0, 3.0, 4.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( 64 ); -* var arr = new Complex128Vector( buf, 16, 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -*/ -declare var ctor: Complex128Vector; - - -// EXPORTS // - -export = ctor; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 8400946..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 r}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-vector-ctor@v0.1.1-esm/index.mjs";var t=r("complex128");export{t as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index fc76095..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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Complex128Vector\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 Complex128Vector();\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 Complex128Vector( 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.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( 64 );\n* var arr = new Complex128Vector( buf );\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( 48 );\n* var arr = new Complex128Vector( buf, 16 );\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( 64 );\n* var arr = new Complex128Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Complex128Vector = factory( 'complex128' );\n\n\n// EXPORTS //\n\nexport default Complex128Vector;\n"],"names":["Complex128Vector","factory"],"mappings":";;yGAuGG,IAACA,EAAmBC,EAAS"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index e10f927..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 7430c1a4e8f1c0145c50c9bb7e3c54dc3ac3a079 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 10 Apr 2026 03:25:16 +0000 Subject: [PATCH 16/37] 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 | 50 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 61 +- 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 | 49 - 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 | 71 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 1022 ---- 45 files changed, 4877 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 6cc3f22..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2026-04-10T03:18:15.563Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 53d0027..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/complex128) 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 eb573d9..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/complex128) 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 f060126..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: '43 19 * * 2' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 83d50c4..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,821 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send notification to Zulip if job fails: - - name: 'Send notification to Zulip in case of failure' - # Pin action to full length commit SHA - uses: zulip/github-actions-zulip/send-message@e4c8f27c732ba9bd98ac6be0583096dea82feea5 # v1.0.2 - if: failure() - with: - api-key: ${{ secrets.ZULIP_API_KEY }} - email: 'github-actions-bot@stdlib.zulipchat.com' - organization-url: 'https://stdlib.zulipchat.com' - to: 'workflows-standalone' - type: 'stream' - topic: ${{ github.event.repository.name }} - content: | - :cross_mark: **${{ github.workflow }}** workflow failed - - **Repository:** [${{ github.repository }}](${{ github.server_url }}/${{ github.repository }}) - **Run:** [View workflow run](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}) - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -231,7 +222,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]. @@ -294,9 +285,9 @@ Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-vector-complex128/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 be3b5e9..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 Complex128Vector = require( './../lib' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var arr; - var i; - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr = new Complex128Vector( 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 cad7cce..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 Complex128Vector = 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 Complex128Vector( 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 ec929f5..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/complex128" -%% click B href "https://github.com/stdlib-js/ndarray-vector-complex128/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-vector-complex128/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-vector-complex128/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-vector-complex128/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-vector-complex128/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/vector/complex128 -[production-url]: https://github.com/stdlib-js/ndarray-vector-complex128/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-vector-complex128/tree/deno -[deno-readme]: https://github.com/stdlib-js/ndarray-vector-complex128/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/ndarray-vector-complex128/tree/umd -[umd-readme]: https://github.com/stdlib-js/ndarray-vector-complex128/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/ndarray-vector-complex128/tree/esm -[esm-readme]: https://github.com/stdlib-js/ndarray-vector-complex128/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 063d577..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var a=function(o,r){return function(){return r||o((r={exports:{}}).exports,r),r.exports}};var t=a(function(u,e){ -var c=require('@stdlib/ndarray-vector-ctor/dist').factory,s=c("complex128");e.exports=s -});var i=t();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 bb0a8c7..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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Complex128Vector\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 Complex128Vector();\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 Complex128Vector( 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.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( 64 );\n* var arr = new Complex128Vector( buf );\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( 48 );\n* var arr = new Complex128Vector( buf, 16 );\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( 64 );\n* var arr = new Complex128Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Complex128Vector = factory( 'complex128' );\n\n\n// EXPORTS //\n\nmodule.exports = Complex128Vector;\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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @module @stdlib/ndarray-vector-complex128\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var v = new Complex128Vector();\n* // returns \n*\n* var len = numel( v );\n* // returns 0\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var v = new Complex128Vector( 2 );\n* // returns \n*\n* var len = numel( v );\n* // returns 2\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var v = new Complex128Vector( [ 1.0, 2.0, 3.0, 4.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 Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var buf = new ArrayBuffer( 64 );\n* var v = new Complex128Vector( buf );\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 Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var buf = new ArrayBuffer( 48 );\n* var v = new Complex128Vector( buf, 16 );\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 Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var buf = new ArrayBuffer( 64 );\n* var v = new Complex128Vector( 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,EAAmBD,EAAS,YAAa,EAK7CD,EAAO,QAAUE,ICdjB,IAAIC,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "factory", "Complex128Vector", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 718f62a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,175 +0,0 @@ - -{{alias}}( [options] ) - Returns a one-dimensional double-precision complex 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 double-precision complex 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 double-precision complex 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, 4.0, 5.0, 6.0 ]; - > var arr = {{alias}}( v ) - - > var len = {{alias:@stdlib/ndarray/numel}}( arr ) - 3 - - -{{alias}}( buffer[, byteOffset[, length]][, options] ) - Returns a one-dimensional double-precision complex 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}}( 64 ); - > var arr = {{alias}}( buf, 0, 2 ) - - > var len = {{alias:@stdlib/ndarray/numel}}( arr ) - 2 - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 79a3121..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 Complex128Vector = require( './index' ); - - -// TESTS // - -// The function returns an ndarray... -{ - new Complex128Vector(); // $ExpectType complex128ndarray - new Complex128Vector( {} ); // $ExpectType complex128ndarray - - new Complex128Vector( 10 ); // $ExpectType complex128ndarray - new Complex128Vector( 10, {} ); // $ExpectType complex128ndarray - - new Complex128Vector( [ 1, 2, 3, 4 ] ); // $ExpectType complex128ndarray - new Complex128Vector( [ 1, 2, 3, 4 ], {} ); // $ExpectType complex128ndarray - - new Complex128Vector( new ArrayBuffer( 10 ) ); // $ExpectType complex128ndarray - new Complex128Vector( new ArrayBuffer( 10 ), {} ); // $ExpectType complex128ndarray - - new Complex128Vector( new ArrayBuffer( 10 ), 8 ); // $ExpectType complex128ndarray - new Complex128Vector( new ArrayBuffer( 10 ), 8, {} ); // $ExpectType complex128ndarray - - new Complex128Vector( new ArrayBuffer( 10 ), 8, 0 ); // $ExpectType complex128ndarray - new Complex128Vector( new ArrayBuffer( 10 ), 8, 0, {} ); // $ExpectType complex128ndarray - - const vector = Complex128Vector; - vector(); // $ExpectType complex128ndarray - vector( {} ); // $ExpectType complex128ndarray - - vector( 10 ); // $ExpectType complex128ndarray - vector( 10, {} ); // $ExpectType complex128ndarray - - vector( [ 1, 2, 3, 4 ] ); // $ExpectType complex128ndarray - vector( [ 1, 2, 3, 4 ], {} ); // $ExpectType complex128ndarray - - vector( new ArrayBuffer( 10 ) ); // $ExpectType complex128ndarray - vector( new ArrayBuffer( 10 ), {} ); // $ExpectType complex128ndarray - - vector( new ArrayBuffer( 10 ), 8 ); // $ExpectType complex128ndarray - vector( new ArrayBuffer( 10 ), 8, {} ); // $ExpectType complex128ndarray - - vector( new ArrayBuffer( 10 ), 8, 0 ); // $ExpectType complex128ndarray - vector( new ArrayBuffer( 10 ), 8, 0, {} ); // $ExpectType complex128ndarray -} - -// 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 Complex128Vector( true ); // $ExpectError - new Complex128Vector( false ); // $ExpectError - new Complex128Vector( null ); // $ExpectError - new Complex128Vector( ( x: number ): number => x ); // $ExpectError - - const vector = Complex128Vector; - 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 Complex128Vector( buf, 8, 2, {}, {} ); // $ExpectError - - const vector = Complex128Vector; - vector( buf, 8, 2, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 0cc3779..0000000 --- a/examples/index.js +++ /dev/null @@ -1,49 +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 real = require( '@stdlib/complex-float64-real' ); -var imag = require( '@stdlib/complex-float64-imag' ); -var Complex128 = require( '@stdlib/complex-float64-ctor' ); -var Complex128Vector = require( './../lib' ); - -// Create a vector containing random values: -var x = new Complex128Vector( discreteUniform( 20, 0, 100 ) ); - -// Compute the sum: -var v = sum( x ); -console.log( v.get() ); - -// Define a function which applies a threshold to real and imaginary components: -function threshold( v ) { - if ( real( v ) > 10 && imag( v ) > 10 ) { - return v; - } - return new Complex128( 0.0, 0.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 deda8c2..5a1608e 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -20,7 +20,7 @@ /* eslint-disable @typescript-eslint/unified-signatures */ -/// +/// import { Order, Mode, complex128ndarray } 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..8400946 --- /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 r}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-vector-ctor@v0.1.1-esm/index.mjs";var t=r("complex128");export{t as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..fc76095 --- /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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Complex128Vector\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 Complex128Vector();\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 Complex128Vector( 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.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( 64 );\n* var arr = new Complex128Vector( buf );\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( 48 );\n* var arr = new Complex128Vector( buf, 16 );\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( 64 );\n* var arr = new Complex128Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Complex128Vector = factory( 'complex128' );\n\n\n// EXPORTS //\n\nexport default Complex128Vector;\n"],"names":["Complex128Vector","factory"],"mappings":";;yGAuGG,IAACA,EAAmBC,EAAS"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 872d251..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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray). -* -* @module @stdlib/ndarray-vector-complex128 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var v = new Complex128Vector(); -* // returns -* -* var len = numel( v ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var v = new Complex128Vector( 2 ); -* // returns -* -* var len = numel( v ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var v = new Complex128Vector( [ 1.0, 2.0, 3.0, 4.0 ] ); -* // returns -* -* var len = numel( v ); -* // returns 2 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var buf = new ArrayBuffer( 64 ); -* var v = new Complex128Vector( buf ); -* // returns -* -* var len = numel( v ); -* // returns 4 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var buf = new ArrayBuffer( 48 ); -* var v = new Complex128Vector( buf, 16 ); -* // returns -* -* var len = numel( v ); -* // returns 2 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var buf = new ArrayBuffer( 64 ); -* var v = new Complex128Vector( 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 e9fb219..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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray). -* -* @name Complex128Vector -* @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 Complex128Vector(); -* // returns -* -* var len = numel( arr ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Complex128Vector( 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Complex128Vector( [ 1.0, 2.0, 3.0, 4.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( 64 ); -* var arr = new Complex128Vector( buf ); -* // returns -* -* var len = numel( arr ); -* // returns 4 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 48 ); -* var arr = new Complex128Vector( buf, 16 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 64 ); -* var arr = new Complex128Vector( buf, 16, 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -*/ -var Complex128Vector = factory( 'complex128' ); - - -// EXPORTS // - -module.exports = Complex128Vector; diff --git a/package.json b/package.json index 007f288..ebe5dcf 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.1", "description": "Create a double-precision complex 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,48 +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-complex128": "^0.3.2", - "@stdlib/array-float32": "^0.2.3", - "@stdlib/assert-is-ndarray-like": "^0.2.3", - "@stdlib/assert-is-ndarray-like-with-data-type": "^0.1.1", - "@stdlib/assert-is-same-complex128array": "^0.2.3", - "@stdlib/blas-ext-sum": "^0.1.1", - "@stdlib/buffer-from-array": "^0.2.3", - "@stdlib/complex-float64-ctor": "^0.1.2", - "@stdlib/complex-float64-imag": "^0.1.2", - "@stdlib/complex-float64-real": "^0.1.2", - "@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", @@ -95,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..e10f927 --- /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 06badd2..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 isSameComplex128Array = require( '@stdlib/assert-is-same-complex128array' ); -var isReadOnly = require( '@stdlib/ndarray-base-assert-is-read-only' ); -var ArrayBuffer = require( '@stdlib/array-buffer' ); -var Float32Array = require( '@stdlib/array-float32' ); -var Complex128Array = require( '@stdlib/array-complex128' ); -var getData = require( '@stdlib/ndarray-data-buffer' ); -var array2buffer = require( '@stdlib/buffer-from-array' ); -var Complex128Vector = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof Complex128Vector, '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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( [], 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector({ - '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 Complex128Vector({ - '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 Complex128Vector({ - 'readonly': value - }); - }; - } -}); - -tape( 'the function returns a one-dimensional ndarray', function test( t ) { - var arr; - - arr = new Complex128Vector(); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - - arr = new Complex128Vector( {} ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( 10 ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, 'returns expected value' ); - - arr = new Complex128Vector( 10, {} ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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, 5.0, 6.0, 7.0, 8.0 ]; - - out = new Complex128Vector( arr ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( arr ) ), true, 'returns expected value' ); - - out = new Complex128Vector( arr, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( 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 Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - - out = new Complex128Vector( arr ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( arr ) ), true, 'returns expected value' ); - - out = new Complex128Vector( arr, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( 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, 5, 6, 7, 8 ]; - buf = array2buffer( arr ); - - out = new Complex128Vector( buf ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( arr ) ), true, 'returns expected value' ); - - out = new Complex128Vector( buf, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( 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( 32 ); - - out = new Complex128Vector( buf ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 2, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( buf ) ), true, 'returns expected value' ); - - out = new Complex128Vector( buf, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 2, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( 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( 64 ); - - out = new Complex128Vector( buf, 16 ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 3, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( buf, 16 ) ), true, 'returns expected value' ); - - out = new Complex128Vector( buf, 16, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 3, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( buf, 16 ) ), 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( 64 ); - - out = new Complex128Vector( buf, 16, 2 ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 2, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( buf, 16, 2 ) ), true, 'returns expected value' ); - - out = new Complex128Vector( buf, 16, 2, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 2, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( buf, 16, 2 ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout', function test( t ) { - var arr; - - arr = new Complex128Vector({ - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Complex128Vector({ - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( 10, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Complex128Vector( 10, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ], { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 4, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Complex128Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ], { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( new ArrayBuffer( 64 ), { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 4, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Complex128Vector( new ArrayBuffer( 64 ), { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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, byteoffset)', function test( t ) { - var arr; - - arr = new Complex128Vector( new ArrayBuffer( 64 ), 16, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 3, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Complex128Vector( new ArrayBuffer( 64 ), 16, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 3, '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 Complex128Vector( new ArrayBuffer( 64 ), 16, 2, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 2, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Complex128Vector( new ArrayBuffer( 64 ), 16, 2, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector({ - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( 10, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ], { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( new ArrayBuffer( 64 ), { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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, byteoffset)', function test( t ) { - var arr; - - arr = new Complex128Vector( new ArrayBuffer( 64 ), 16, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 3, '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 Complex128Vector( new ArrayBuffer( 64 ), 16, 2, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector({ - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( 10, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ], { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( new ArrayBuffer( 64 ), { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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, byteoffset)', function test( t ) { - var arr; - - arr = new Complex128Vector( new ArrayBuffer( 64 ), 16, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 3, '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 Complex128Vector( new ArrayBuffer( 64 ), 16, 2, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 2, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); From 7e9f8ad3b6f9fed0f181e3c0a851f2f8f7be7c52 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 17 Apr 2026 10:59:33 +0000 Subject: [PATCH 17/37] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index ecac788..314dcca 100644 --- a/package.json +++ b/package.json @@ -57,7 +57,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 f8e2b75257a34a8c062023e64715e6aa2386c3a8 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 17 Apr 2026 11:17:46 +0000 Subject: [PATCH 18/37] 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 5a1608e..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, complex128ndarray } 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 Complex128Vector { - /** - * Creates a double-precision complex 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 Complex128Vector(); - * // returns - * - * var len = numel( arr ); - * // returns 0 - */ - new ( options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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 Complex128Vector( 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( length: number, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.0 ] ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( obj: Collection | AccessorArrayLike | Iterable, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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 Complex128Vector( buf ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( buffer: ArrayBuffer, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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( 64 ); - * var arr = new Complex128Vector( buf, 16 ); - * // returns - * - * var len = numel( arr ); - * // returns 3 - */ - new ( buffer: ArrayBuffer, byteOffset: number, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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( 64 ); - * var arr = new Complex128Vector( buf, 16, 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( buffer: ArrayBuffer, byteOffset: number, length: number, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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 Complex128Vector(); - * // returns - * - * var len = numel( arr ); - * // returns 0 - */ - ( options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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 Complex128Vector( 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( length: number, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.0 ] ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( obj: Collection | AccessorArrayLike | Iterable, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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( 64 ); - * var arr = new Complex128Vector( buf ); - * // returns - * - * var len = numel( arr ); - * // returns 4 - */ - ( buffer: ArrayBuffer, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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( 64 ); - * var arr = new Complex128Vector( buf, 16 ); - * // returns - * - * var len = numel( arr ); - * // returns 3 - */ - ( buffer: ArrayBuffer, byteOffset: number, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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( 64 ); - * var arr = new Complex128Vector( buf, 16, 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( buffer: ArrayBuffer, byteOffset: number, length: number, options?: Options ): complex128ndarray; -} - -/** -* Creates a double-precision complex 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 Complex128Vector(); -* // returns -* -* var len = numel( arr ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Complex128Vector( 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Complex128Vector( [ 1.0, 2.0, 3.0, 4.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( 64 ); -* var arr = new Complex128Vector( buf, 16, 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -*/ -declare var ctor: Complex128Vector; - - -// EXPORTS // - -export = ctor; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 8400946..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 r}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-vector-ctor@v0.1.1-esm/index.mjs";var t=r("complex128");export{t as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index fc76095..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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Complex128Vector\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 Complex128Vector();\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 Complex128Vector( 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.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( 64 );\n* var arr = new Complex128Vector( buf );\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( 48 );\n* var arr = new Complex128Vector( buf, 16 );\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( 64 );\n* var arr = new Complex128Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Complex128Vector = factory( 'complex128' );\n\n\n// EXPORTS //\n\nexport default Complex128Vector;\n"],"names":["Complex128Vector","factory"],"mappings":";;yGAuGG,IAACA,EAAmBC,EAAS"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index e10f927..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From e659883737a2eb0f25c8b9aefd80006bf379690e Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 17 Apr 2026 11:18:16 +0000 Subject: [PATCH 19/37] 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 | 84 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 61 +- 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 | 49 - 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 | 69 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 1022 ---- 44 files changed, 4876 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 53d0027..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/complex128) 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 eb573d9..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/complex128) 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 f060126..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: '43 19 * * 2' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 83d50c4..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,821 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send notification to Zulip if job fails: - - name: 'Send notification to Zulip in case of failure' - # Pin action to full length commit SHA - uses: zulip/github-actions-zulip/send-message@e4c8f27c732ba9bd98ac6be0583096dea82feea5 # v1.0.2 - if: failure() - with: - api-key: ${{ secrets.ZULIP_API_KEY }} - email: 'github-actions-bot@stdlib.zulipchat.com' - organization-url: 'https://stdlib.zulipchat.com' - to: 'workflows-standalone' - type: 'stream' - topic: ${{ github.event.repository.name }} - content: | - :cross_mark: **${{ github.workflow }}** workflow failed - - **Repository:** [${{ github.repository }}](${{ github.server_url }}/${{ github.repository }}) - **Run:** [View workflow run](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}) - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -231,7 +222,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]. @@ -294,9 +285,9 @@ Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-vector-complex128/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 be3b5e9..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 Complex128Vector = require( './../lib' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var arr; - var i; - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr = new Complex128Vector( 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 6331119..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 Complex128Vector = 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 Complex128Vector( 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 ec929f5..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/complex128" -%% click B href "https://github.com/stdlib-js/ndarray-vector-complex128/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-vector-complex128/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-vector-complex128/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-vector-complex128/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-vector-complex128/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/vector/complex128 -[production-url]: https://github.com/stdlib-js/ndarray-vector-complex128/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-vector-complex128/tree/deno -[deno-readme]: https://github.com/stdlib-js/ndarray-vector-complex128/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/ndarray-vector-complex128/tree/umd -[umd-readme]: https://github.com/stdlib-js/ndarray-vector-complex128/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/ndarray-vector-complex128/tree/esm -[esm-readme]: https://github.com/stdlib-js/ndarray-vector-complex128/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 063d577..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var a=function(o,r){return function(){return r||o((r={exports:{}}).exports,r),r.exports}};var t=a(function(u,e){ -var c=require('@stdlib/ndarray-vector-ctor/dist').factory,s=c("complex128");e.exports=s -});var i=t();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 bb0a8c7..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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Complex128Vector\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 Complex128Vector();\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 Complex128Vector( 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.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( 64 );\n* var arr = new Complex128Vector( buf );\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( 48 );\n* var arr = new Complex128Vector( buf, 16 );\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( 64 );\n* var arr = new Complex128Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Complex128Vector = factory( 'complex128' );\n\n\n// EXPORTS //\n\nmodule.exports = Complex128Vector;\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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @module @stdlib/ndarray-vector-complex128\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var v = new Complex128Vector();\n* // returns \n*\n* var len = numel( v );\n* // returns 0\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var v = new Complex128Vector( 2 );\n* // returns \n*\n* var len = numel( v );\n* // returns 2\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var v = new Complex128Vector( [ 1.0, 2.0, 3.0, 4.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 Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var buf = new ArrayBuffer( 64 );\n* var v = new Complex128Vector( buf );\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 Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var buf = new ArrayBuffer( 48 );\n* var v = new Complex128Vector( buf, 16 );\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 Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var buf = new ArrayBuffer( 64 );\n* var v = new Complex128Vector( 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,EAAmBD,EAAS,YAAa,EAK7CD,EAAO,QAAUE,ICdjB,IAAIC,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "factory", "Complex128Vector", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 718f62a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,175 +0,0 @@ - -{{alias}}( [options] ) - Returns a one-dimensional double-precision complex 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 double-precision complex 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 double-precision complex 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, 4.0, 5.0, 6.0 ]; - > var arr = {{alias}}( v ) - - > var len = {{alias:@stdlib/ndarray/numel}}( arr ) - 3 - - -{{alias}}( buffer[, byteOffset[, length]][, options] ) - Returns a one-dimensional double-precision complex 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}}( 64 ); - > var arr = {{alias}}( buf, 0, 2 ) - - > var len = {{alias:@stdlib/ndarray/numel}}( arr ) - 2 - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 79a3121..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 Complex128Vector = require( './index' ); - - -// TESTS // - -// The function returns an ndarray... -{ - new Complex128Vector(); // $ExpectType complex128ndarray - new Complex128Vector( {} ); // $ExpectType complex128ndarray - - new Complex128Vector( 10 ); // $ExpectType complex128ndarray - new Complex128Vector( 10, {} ); // $ExpectType complex128ndarray - - new Complex128Vector( [ 1, 2, 3, 4 ] ); // $ExpectType complex128ndarray - new Complex128Vector( [ 1, 2, 3, 4 ], {} ); // $ExpectType complex128ndarray - - new Complex128Vector( new ArrayBuffer( 10 ) ); // $ExpectType complex128ndarray - new Complex128Vector( new ArrayBuffer( 10 ), {} ); // $ExpectType complex128ndarray - - new Complex128Vector( new ArrayBuffer( 10 ), 8 ); // $ExpectType complex128ndarray - new Complex128Vector( new ArrayBuffer( 10 ), 8, {} ); // $ExpectType complex128ndarray - - new Complex128Vector( new ArrayBuffer( 10 ), 8, 0 ); // $ExpectType complex128ndarray - new Complex128Vector( new ArrayBuffer( 10 ), 8, 0, {} ); // $ExpectType complex128ndarray - - const vector = Complex128Vector; - vector(); // $ExpectType complex128ndarray - vector( {} ); // $ExpectType complex128ndarray - - vector( 10 ); // $ExpectType complex128ndarray - vector( 10, {} ); // $ExpectType complex128ndarray - - vector( [ 1, 2, 3, 4 ] ); // $ExpectType complex128ndarray - vector( [ 1, 2, 3, 4 ], {} ); // $ExpectType complex128ndarray - - vector( new ArrayBuffer( 10 ) ); // $ExpectType complex128ndarray - vector( new ArrayBuffer( 10 ), {} ); // $ExpectType complex128ndarray - - vector( new ArrayBuffer( 10 ), 8 ); // $ExpectType complex128ndarray - vector( new ArrayBuffer( 10 ), 8, {} ); // $ExpectType complex128ndarray - - vector( new ArrayBuffer( 10 ), 8, 0 ); // $ExpectType complex128ndarray - vector( new ArrayBuffer( 10 ), 8, 0, {} ); // $ExpectType complex128ndarray -} - -// 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 Complex128Vector( true ); // $ExpectError - new Complex128Vector( false ); // $ExpectError - new Complex128Vector( null ); // $ExpectError - new Complex128Vector( ( x: number ): number => x ); // $ExpectError - - const vector = Complex128Vector; - 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 Complex128Vector( buf, 8, 2, {}, {} ); // $ExpectError - - const vector = Complex128Vector; - vector( buf, 8, 2, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 0cc3779..0000000 --- a/examples/index.js +++ /dev/null @@ -1,49 +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 real = require( '@stdlib/complex-float64-real' ); -var imag = require( '@stdlib/complex-float64-imag' ); -var Complex128 = require( '@stdlib/complex-float64-ctor' ); -var Complex128Vector = require( './../lib' ); - -// Create a vector containing random values: -var x = new Complex128Vector( discreteUniform( 20, 0, 100 ) ); - -// Compute the sum: -var v = sum( x ); -console.log( v.get() ); - -// Define a function which applies a threshold to real and imaginary components: -function threshold( v ) { - if ( real( v ) > 10 && imag( v ) > 10 ) { - return v; - } - return new Complex128( 0.0, 0.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 deda8c2..5a1608e 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -20,7 +20,7 @@ /* eslint-disable @typescript-eslint/unified-signatures */ -/// +/// import { Order, Mode, complex128ndarray } 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..8400946 --- /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 r}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-vector-ctor@v0.1.1-esm/index.mjs";var t=r("complex128");export{t as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..fc76095 --- /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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Complex128Vector\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 Complex128Vector();\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 Complex128Vector( 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.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( 64 );\n* var arr = new Complex128Vector( buf );\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( 48 );\n* var arr = new Complex128Vector( buf, 16 );\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( 64 );\n* var arr = new Complex128Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Complex128Vector = factory( 'complex128' );\n\n\n// EXPORTS //\n\nexport default Complex128Vector;\n"],"names":["Complex128Vector","factory"],"mappings":";;yGAuGG,IAACA,EAAmBC,EAAS"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 872d251..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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray). -* -* @module @stdlib/ndarray-vector-complex128 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var v = new Complex128Vector(); -* // returns -* -* var len = numel( v ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var v = new Complex128Vector( 2 ); -* // returns -* -* var len = numel( v ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var v = new Complex128Vector( [ 1.0, 2.0, 3.0, 4.0 ] ); -* // returns -* -* var len = numel( v ); -* // returns 2 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var buf = new ArrayBuffer( 64 ); -* var v = new Complex128Vector( buf ); -* // returns -* -* var len = numel( v ); -* // returns 4 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var buf = new ArrayBuffer( 48 ); -* var v = new Complex128Vector( buf, 16 ); -* // returns -* -* var len = numel( v ); -* // returns 2 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var buf = new ArrayBuffer( 64 ); -* var v = new Complex128Vector( 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 e9fb219..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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray). -* -* @name Complex128Vector -* @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 Complex128Vector(); -* // returns -* -* var len = numel( arr ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Complex128Vector( 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Complex128Vector( [ 1.0, 2.0, 3.0, 4.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( 64 ); -* var arr = new Complex128Vector( buf ); -* // returns -* -* var len = numel( arr ); -* // returns 4 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 48 ); -* var arr = new Complex128Vector( buf, 16 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 64 ); -* var arr = new Complex128Vector( buf, 16, 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -*/ -var Complex128Vector = factory( 'complex128' ); - - -// EXPORTS // - -module.exports = Complex128Vector; diff --git a/package.json b/package.json index 314dcca..ebe5dcf 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.1", "description": "Create a double-precision complex 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,48 +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-complex128": "^0.3.2", - "@stdlib/array-float32": "^0.2.3", - "@stdlib/assert-is-ndarray-like": "^0.2.3", - "@stdlib/assert-is-ndarray-like-with-data-type": "^0.1.1", - "@stdlib/assert-is-same-complex128array": "^0.2.3", - "@stdlib/blas-ext-sum": "^0.1.1", - "@stdlib/buffer-from-array": "^0.2.3", - "@stdlib/complex-float64-ctor": "^0.1.2", - "@stdlib/complex-float64-imag": "^0.1.2", - "@stdlib/complex-float64-real": "^0.1.2", - "@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..e10f927 --- /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 06badd2..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 isSameComplex128Array = require( '@stdlib/assert-is-same-complex128array' ); -var isReadOnly = require( '@stdlib/ndarray-base-assert-is-read-only' ); -var ArrayBuffer = require( '@stdlib/array-buffer' ); -var Float32Array = require( '@stdlib/array-float32' ); -var Complex128Array = require( '@stdlib/array-complex128' ); -var getData = require( '@stdlib/ndarray-data-buffer' ); -var array2buffer = require( '@stdlib/buffer-from-array' ); -var Complex128Vector = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof Complex128Vector, '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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( [], 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector({ - '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 Complex128Vector({ - '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 Complex128Vector({ - 'readonly': value - }); - }; - } -}); - -tape( 'the function returns a one-dimensional ndarray', function test( t ) { - var arr; - - arr = new Complex128Vector(); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - - arr = new Complex128Vector( {} ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( 10 ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, 'returns expected value' ); - - arr = new Complex128Vector( 10, {} ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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, 5.0, 6.0, 7.0, 8.0 ]; - - out = new Complex128Vector( arr ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( arr ) ), true, 'returns expected value' ); - - out = new Complex128Vector( arr, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( 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 Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - - out = new Complex128Vector( arr ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( arr ) ), true, 'returns expected value' ); - - out = new Complex128Vector( arr, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( 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, 5, 6, 7, 8 ]; - buf = array2buffer( arr ); - - out = new Complex128Vector( buf ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( arr ) ), true, 'returns expected value' ); - - out = new Complex128Vector( buf, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( 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( 32 ); - - out = new Complex128Vector( buf ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 2, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( buf ) ), true, 'returns expected value' ); - - out = new Complex128Vector( buf, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 2, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( 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( 64 ); - - out = new Complex128Vector( buf, 16 ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 3, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( buf, 16 ) ), true, 'returns expected value' ); - - out = new Complex128Vector( buf, 16, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 3, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( buf, 16 ) ), 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( 64 ); - - out = new Complex128Vector( buf, 16, 2 ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 2, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( buf, 16, 2 ) ), true, 'returns expected value' ); - - out = new Complex128Vector( buf, 16, 2, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( out.length, 2, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( buf, 16, 2 ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout', function test( t ) { - var arr; - - arr = new Complex128Vector({ - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 0, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Complex128Vector({ - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( 10, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 10, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Complex128Vector( 10, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ], { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 4, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Complex128Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ], { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( new ArrayBuffer( 64 ), { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 4, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Complex128Vector( new ArrayBuffer( 64 ), { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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, byteoffset)', function test( t ) { - var arr; - - arr = new Complex128Vector( new ArrayBuffer( 64 ), 16, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 3, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Complex128Vector( new ArrayBuffer( 64 ), 16, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 3, '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 Complex128Vector( new ArrayBuffer( 64 ), 16, 2, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 2, 'returns expected value' ); - t.strictEqual( arr.order, 'row-major', 'returns expected value' ); - - arr = new Complex128Vector( new ArrayBuffer( 64 ), 16, 2, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector({ - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( 10, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ], { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( new ArrayBuffer( 64 ), { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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, byteoffset)', function test( t ) { - var arr; - - arr = new Complex128Vector( new ArrayBuffer( 64 ), 16, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 3, '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 Complex128Vector( new ArrayBuffer( 64 ), 16, 2, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector({ - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( 10, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ], { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( new ArrayBuffer( 64 ), { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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, byteoffset)', function test( t ) { - var arr; - - arr = new Complex128Vector( new ArrayBuffer( 64 ), 16, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 3, '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 Complex128Vector( new ArrayBuffer( 64 ), 16, 2, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( arr.length, 2, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); From ef639b3a7106627dc6665a8b2209de3bf49b4f58 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 18 May 2026 12:18:32 +0000 Subject: [PATCH 20/37] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index c06e4ef..d981c1f 100644 --- a/package.json +++ b/package.json @@ -59,7 +59,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 361ad7763c842bb8ec5bb3152265d96bf25731c6 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 18 May 2026 12:37:18 +0000 Subject: [PATCH 21/37] 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 5a1608e..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, complex128ndarray } 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 Complex128Vector { - /** - * Creates a double-precision complex 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 Complex128Vector(); - * // returns - * - * var len = numel( arr ); - * // returns 0 - */ - new ( options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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 Complex128Vector( 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( length: number, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.0 ] ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( obj: Collection | AccessorArrayLike | Iterable, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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 Complex128Vector( buf ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( buffer: ArrayBuffer, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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( 64 ); - * var arr = new Complex128Vector( buf, 16 ); - * // returns - * - * var len = numel( arr ); - * // returns 3 - */ - new ( buffer: ArrayBuffer, byteOffset: number, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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( 64 ); - * var arr = new Complex128Vector( buf, 16, 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( buffer: ArrayBuffer, byteOffset: number, length: number, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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 Complex128Vector(); - * // returns - * - * var len = numel( arr ); - * // returns 0 - */ - ( options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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 Complex128Vector( 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( length: number, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.0 ] ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( obj: Collection | AccessorArrayLike | Iterable, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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( 64 ); - * var arr = new Complex128Vector( buf ); - * // returns - * - * var len = numel( arr ); - * // returns 4 - */ - ( buffer: ArrayBuffer, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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( 64 ); - * var arr = new Complex128Vector( buf, 16 ); - * // returns - * - * var len = numel( arr ); - * // returns 3 - */ - ( buffer: ArrayBuffer, byteOffset: number, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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( 64 ); - * var arr = new Complex128Vector( buf, 16, 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( buffer: ArrayBuffer, byteOffset: number, length: number, options?: Options ): complex128ndarray; -} - -/** -* Creates a double-precision complex 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 Complex128Vector(); -* // returns -* -* var len = numel( arr ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Complex128Vector( 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Complex128Vector( [ 1.0, 2.0, 3.0, 4.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( 64 ); -* var arr = new Complex128Vector( buf, 16, 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -*/ -declare var ctor: Complex128Vector; - - -// EXPORTS // - -export = ctor; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 8400946..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 r}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-vector-ctor@v0.1.1-esm/index.mjs";var t=r("complex128");export{t as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index fc76095..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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Complex128Vector\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 Complex128Vector();\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 Complex128Vector( 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.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( 64 );\n* var arr = new Complex128Vector( buf );\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( 48 );\n* var arr = new Complex128Vector( buf, 16 );\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( 64 );\n* var arr = new Complex128Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Complex128Vector = factory( 'complex128' );\n\n\n// EXPORTS //\n\nexport default Complex128Vector;\n"],"names":["Complex128Vector","factory"],"mappings":";;yGAuGG,IAACA,EAAmBC,EAAS"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index e10f927..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 5a2e475d5b6e402d312ee678127321afc022bdf6 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 18 May 2026 12:38:09 +0000 Subject: [PATCH 22/37] 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 | 86 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 61 +- 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 | 49 - 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 | 71 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 1024 ---- 44 files changed, 4876 insertions(+), 5381 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 53d0027..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/complex128) 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 eb573d9..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/complex128) 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 f060126..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: '43 19 * * 2' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 83d50c4..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,821 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send notification to Zulip if job fails: - - name: 'Send notification to Zulip in case of failure' - # Pin action to full length commit SHA - uses: zulip/github-actions-zulip/send-message@e4c8f27c732ba9bd98ac6be0583096dea82feea5 # v1.0.2 - if: failure() - with: - api-key: ${{ secrets.ZULIP_API_KEY }} - email: 'github-actions-bot@stdlib.zulipchat.com' - organization-url: 'https://stdlib.zulipchat.com' - to: 'workflows-standalone' - type: 'stream' - topic: ${{ github.event.repository.name }} - content: | - :cross_mark: **${{ github.workflow }}** workflow failed - - **Repository:** [${{ github.repository }}](${{ github.server_url }}/${{ github.repository }}) - **Run:** [View workflow run](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}) - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -231,7 +222,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]. @@ -294,9 +285,9 @@ Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-vector-complex128/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 be3b5e9..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 Complex128Vector = require( './../lib' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var arr; - var i; - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr = new Complex128Vector( 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 6331119..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 Complex128Vector = 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 Complex128Vector( 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 ec929f5..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/complex128" -%% click B href "https://github.com/stdlib-js/ndarray-vector-complex128/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-vector-complex128/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-vector-complex128/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-vector-complex128/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-vector-complex128/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/vector/complex128 -[production-url]: https://github.com/stdlib-js/ndarray-vector-complex128/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-vector-complex128/tree/deno -[deno-readme]: https://github.com/stdlib-js/ndarray-vector-complex128/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/ndarray-vector-complex128/tree/umd -[umd-readme]: https://github.com/stdlib-js/ndarray-vector-complex128/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/ndarray-vector-complex128/tree/esm -[esm-readme]: https://github.com/stdlib-js/ndarray-vector-complex128/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 063d577..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var a=function(o,r){return function(){return r||o((r={exports:{}}).exports,r),r.exports}};var t=a(function(u,e){ -var c=require('@stdlib/ndarray-vector-ctor/dist').factory,s=c("complex128");e.exports=s -});var i=t();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 bb0a8c7..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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Complex128Vector\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 Complex128Vector();\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 Complex128Vector( 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.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( 64 );\n* var arr = new Complex128Vector( buf );\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( 48 );\n* var arr = new Complex128Vector( buf, 16 );\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( 64 );\n* var arr = new Complex128Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Complex128Vector = factory( 'complex128' );\n\n\n// EXPORTS //\n\nmodule.exports = Complex128Vector;\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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @module @stdlib/ndarray-vector-complex128\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var v = new Complex128Vector();\n* // returns \n*\n* var len = numel( v );\n* // returns 0\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var v = new Complex128Vector( 2 );\n* // returns \n*\n* var len = numel( v );\n* // returns 2\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var v = new Complex128Vector( [ 1.0, 2.0, 3.0, 4.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 Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var buf = new ArrayBuffer( 64 );\n* var v = new Complex128Vector( buf );\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 Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var buf = new ArrayBuffer( 48 );\n* var v = new Complex128Vector( buf, 16 );\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 Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var buf = new ArrayBuffer( 64 );\n* var v = new Complex128Vector( 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,EAAmBD,EAAS,YAAa,EAK7CD,EAAO,QAAUE,ICdjB,IAAIC,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "factory", "Complex128Vector", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 718f62a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,175 +0,0 @@ - -{{alias}}( [options] ) - Returns a one-dimensional double-precision complex 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 double-precision complex 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 double-precision complex 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, 4.0, 5.0, 6.0 ]; - > var arr = {{alias}}( v ) - - > var len = {{alias:@stdlib/ndarray/numel}}( arr ) - 3 - - -{{alias}}( buffer[, byteOffset[, length]][, options] ) - Returns a one-dimensional double-precision complex 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}}( 64 ); - > var arr = {{alias}}( buf, 0, 2 ) - - > var len = {{alias:@stdlib/ndarray/numel}}( arr ) - 2 - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 79a3121..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 Complex128Vector = require( './index' ); - - -// TESTS // - -// The function returns an ndarray... -{ - new Complex128Vector(); // $ExpectType complex128ndarray - new Complex128Vector( {} ); // $ExpectType complex128ndarray - - new Complex128Vector( 10 ); // $ExpectType complex128ndarray - new Complex128Vector( 10, {} ); // $ExpectType complex128ndarray - - new Complex128Vector( [ 1, 2, 3, 4 ] ); // $ExpectType complex128ndarray - new Complex128Vector( [ 1, 2, 3, 4 ], {} ); // $ExpectType complex128ndarray - - new Complex128Vector( new ArrayBuffer( 10 ) ); // $ExpectType complex128ndarray - new Complex128Vector( new ArrayBuffer( 10 ), {} ); // $ExpectType complex128ndarray - - new Complex128Vector( new ArrayBuffer( 10 ), 8 ); // $ExpectType complex128ndarray - new Complex128Vector( new ArrayBuffer( 10 ), 8, {} ); // $ExpectType complex128ndarray - - new Complex128Vector( new ArrayBuffer( 10 ), 8, 0 ); // $ExpectType complex128ndarray - new Complex128Vector( new ArrayBuffer( 10 ), 8, 0, {} ); // $ExpectType complex128ndarray - - const vector = Complex128Vector; - vector(); // $ExpectType complex128ndarray - vector( {} ); // $ExpectType complex128ndarray - - vector( 10 ); // $ExpectType complex128ndarray - vector( 10, {} ); // $ExpectType complex128ndarray - - vector( [ 1, 2, 3, 4 ] ); // $ExpectType complex128ndarray - vector( [ 1, 2, 3, 4 ], {} ); // $ExpectType complex128ndarray - - vector( new ArrayBuffer( 10 ) ); // $ExpectType complex128ndarray - vector( new ArrayBuffer( 10 ), {} ); // $ExpectType complex128ndarray - - vector( new ArrayBuffer( 10 ), 8 ); // $ExpectType complex128ndarray - vector( new ArrayBuffer( 10 ), 8, {} ); // $ExpectType complex128ndarray - - vector( new ArrayBuffer( 10 ), 8, 0 ); // $ExpectType complex128ndarray - vector( new ArrayBuffer( 10 ), 8, 0, {} ); // $ExpectType complex128ndarray -} - -// 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 Complex128Vector( true ); // $ExpectError - new Complex128Vector( false ); // $ExpectError - new Complex128Vector( null ); // $ExpectError - new Complex128Vector( ( x: number ): number => x ); // $ExpectError - - const vector = Complex128Vector; - 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 Complex128Vector( buf, 8, 2, {}, {} ); // $ExpectError - - const vector = Complex128Vector; - vector( buf, 8, 2, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 0cc3779..0000000 --- a/examples/index.js +++ /dev/null @@ -1,49 +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 real = require( '@stdlib/complex-float64-real' ); -var imag = require( '@stdlib/complex-float64-imag' ); -var Complex128 = require( '@stdlib/complex-float64-ctor' ); -var Complex128Vector = require( './../lib' ); - -// Create a vector containing random values: -var x = new Complex128Vector( discreteUniform( 20, 0, 100 ) ); - -// Compute the sum: -var v = sum( x ); -console.log( v.get() ); - -// Define a function which applies a threshold to real and imaginary components: -function threshold( v ) { - if ( real( v ) > 10 && imag( v ) > 10 ) { - return v; - } - return new Complex128( 0.0, 0.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 deda8c2..5a1608e 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -20,7 +20,7 @@ /* eslint-disable @typescript-eslint/unified-signatures */ -/// +/// import { Order, Mode, complex128ndarray } 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..8400946 --- /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 r}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-vector-ctor@v0.1.1-esm/index.mjs";var t=r("complex128");export{t as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..fc76095 --- /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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Complex128Vector\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 Complex128Vector();\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 Complex128Vector( 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.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( 64 );\n* var arr = new Complex128Vector( buf );\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( 48 );\n* var arr = new Complex128Vector( buf, 16 );\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( 64 );\n* var arr = new Complex128Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Complex128Vector = factory( 'complex128' );\n\n\n// EXPORTS //\n\nexport default Complex128Vector;\n"],"names":["Complex128Vector","factory"],"mappings":";;yGAuGG,IAACA,EAAmBC,EAAS"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 872d251..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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray). -* -* @module @stdlib/ndarray-vector-complex128 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var v = new Complex128Vector(); -* // returns -* -* var len = numel( v ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var v = new Complex128Vector( 2 ); -* // returns -* -* var len = numel( v ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var v = new Complex128Vector( [ 1.0, 2.0, 3.0, 4.0 ] ); -* // returns -* -* var len = numel( v ); -* // returns 2 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var buf = new ArrayBuffer( 64 ); -* var v = new Complex128Vector( buf ); -* // returns -* -* var len = numel( v ); -* // returns 4 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var buf = new ArrayBuffer( 48 ); -* var v = new Complex128Vector( buf, 16 ); -* // returns -* -* var len = numel( v ); -* // returns 2 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var buf = new ArrayBuffer( 64 ); -* var v = new Complex128Vector( 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 e9fb219..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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray). -* -* @name Complex128Vector -* @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 Complex128Vector(); -* // returns -* -* var len = numel( arr ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Complex128Vector( 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Complex128Vector( [ 1.0, 2.0, 3.0, 4.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( 64 ); -* var arr = new Complex128Vector( buf ); -* // returns -* -* var len = numel( arr ); -* // returns 4 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 48 ); -* var arr = new Complex128Vector( buf, 16 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 64 ); -* var arr = new Complex128Vector( buf, 16, 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -*/ -var Complex128Vector = factory( 'complex128' ); - - -// EXPORTS // - -module.exports = Complex128Vector; diff --git a/package.json b/package.json index d981c1f..ebe5dcf 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.1", "description": "Create a double-precision complex 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,50 +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-complex128": "^0.3.2", - "@stdlib/array-float32": "^0.2.3", - "@stdlib/assert-is-ndarray-like": "^0.2.3", - "@stdlib/assert-is-ndarray-like-with-data-type": "^0.1.1", - "@stdlib/assert-is-same-complex128array": "^0.2.3", - "@stdlib/blas-ext-sum": "^0.1.1", - "@stdlib/buffer-from-array": "^0.2.3", - "@stdlib/complex-float64-ctor": "^0.1.2", - "@stdlib/complex-float64-imag": "^0.1.2", - "@stdlib/complex-float64-real": "^0.1.2", - "@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..e10f927 --- /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 be638c1..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 isSameComplex128Array = require( '@stdlib/assert-is-same-complex128array' ); -var isReadOnly = require( '@stdlib/ndarray-base-assert-is-read-only' ); -var ArrayBuffer = require( '@stdlib/array-buffer' ); -var Float32Array = require( '@stdlib/array-float32' ); -var Complex128Array = require( '@stdlib/array-complex128' ); -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 Complex128Vector = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof Complex128Vector, '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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( [], 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector({ - '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 Complex128Vector({ - '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 Complex128Vector({ - 'readonly': value - }); - }; - } -}); - -tape( 'the function returns a one-dimensional ndarray', function test( t ) { - var arr; - - arr = new Complex128Vector(); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 0, 'returns expected value' ); - - arr = new Complex128Vector( {} ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( 10 ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 10, 'returns expected value' ); - - arr = new Complex128Vector( 10, {} ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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, 5.0, 6.0, 7.0, 8.0 ]; - - out = new Complex128Vector( arr ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( arr ) ), true, 'returns expected value' ); - - out = new Complex128Vector( arr, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( 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 Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - - out = new Complex128Vector( arr ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( arr ) ), true, 'returns expected value' ); - - out = new Complex128Vector( arr, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( 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, 5, 6, 7, 8 ]; - buf = array2buffer( arr ); - - out = new Complex128Vector( buf ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( arr ) ), true, 'returns expected value' ); - - out = new Complex128Vector( buf, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( 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( 32 ); - - out = new Complex128Vector( buf ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 2, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( buf ) ), true, 'returns expected value' ); - - out = new Complex128Vector( buf, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 2, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( 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( 64 ); - - out = new Complex128Vector( buf, 16 ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 3, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( buf, 16 ) ), true, 'returns expected value' ); - - out = new Complex128Vector( buf, 16, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 3, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( buf, 16 ) ), 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( 64 ); - - out = new Complex128Vector( buf, 16, 2 ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 2, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( buf, 16, 2 ) ), true, 'returns expected value' ); - - out = new Complex128Vector( buf, 16, 2, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 2, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( buf, 16, 2 ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout', function test( t ) { - var arr; - - arr = new Complex128Vector({ - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 0, 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Complex128Vector({ - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( 10, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 10, 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Complex128Vector( 10, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ], { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 4, 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Complex128Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ], { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( new ArrayBuffer( 64 ), { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 4, 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Complex128Vector( new ArrayBuffer( 64 ), { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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, byteoffset)', function test( t ) { - var arr; - - arr = new Complex128Vector( new ArrayBuffer( 64 ), 16, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 3, 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Complex128Vector( new ArrayBuffer( 64 ), 16, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 3, '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 Complex128Vector( new ArrayBuffer( 64 ), 16, 2, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 2, 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Complex128Vector( new ArrayBuffer( 64 ), 16, 2, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector({ - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( 10, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ], { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( new ArrayBuffer( 64 ), { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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, byteoffset)', function test( t ) { - var arr; - - arr = new Complex128Vector( new ArrayBuffer( 64 ), 16, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 3, '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 Complex128Vector( new ArrayBuffer( 64 ), 16, 2, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector({ - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( 10, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ], { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( new ArrayBuffer( 64 ), { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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, byteoffset)', function test( t ) { - var arr; - - arr = new Complex128Vector( new ArrayBuffer( 64 ), 16, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 3, '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 Complex128Vector( new ArrayBuffer( 64 ), 16, 2, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 2, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); From 4ebf123cfd463667a3daf3247c908be5468b1a15 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 21 May 2026 03:24:26 +0000 Subject: [PATCH 23/37] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index c06e4ef..d981c1f 100644 --- a/package.json +++ b/package.json @@ -59,7 +59,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 fd115025dd1bd3dd0cacd4d3276582cdbb5df638 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 21 May 2026 03:29:04 +0000 Subject: [PATCH 24/37] 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 5a1608e..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, complex128ndarray } 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 Complex128Vector { - /** - * Creates a double-precision complex 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 Complex128Vector(); - * // returns - * - * var len = numel( arr ); - * // returns 0 - */ - new ( options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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 Complex128Vector( 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( length: number, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.0 ] ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( obj: Collection | AccessorArrayLike | Iterable, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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 Complex128Vector( buf ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( buffer: ArrayBuffer, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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( 64 ); - * var arr = new Complex128Vector( buf, 16 ); - * // returns - * - * var len = numel( arr ); - * // returns 3 - */ - new ( buffer: ArrayBuffer, byteOffset: number, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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( 64 ); - * var arr = new Complex128Vector( buf, 16, 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( buffer: ArrayBuffer, byteOffset: number, length: number, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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 Complex128Vector(); - * // returns - * - * var len = numel( arr ); - * // returns 0 - */ - ( options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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 Complex128Vector( 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( length: number, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.0 ] ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( obj: Collection | AccessorArrayLike | Iterable, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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( 64 ); - * var arr = new Complex128Vector( buf ); - * // returns - * - * var len = numel( arr ); - * // returns 4 - */ - ( buffer: ArrayBuffer, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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( 64 ); - * var arr = new Complex128Vector( buf, 16 ); - * // returns - * - * var len = numel( arr ); - * // returns 3 - */ - ( buffer: ArrayBuffer, byteOffset: number, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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( 64 ); - * var arr = new Complex128Vector( buf, 16, 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( buffer: ArrayBuffer, byteOffset: number, length: number, options?: Options ): complex128ndarray; -} - -/** -* Creates a double-precision complex 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 Complex128Vector(); -* // returns -* -* var len = numel( arr ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Complex128Vector( 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Complex128Vector( [ 1.0, 2.0, 3.0, 4.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( 64 ); -* var arr = new Complex128Vector( buf, 16, 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -*/ -declare var ctor: Complex128Vector; - - -// EXPORTS // - -export = ctor; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 8400946..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 r}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-vector-ctor@v0.1.1-esm/index.mjs";var t=r("complex128");export{t as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index fc76095..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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Complex128Vector\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 Complex128Vector();\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 Complex128Vector( 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.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( 64 );\n* var arr = new Complex128Vector( buf );\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( 48 );\n* var arr = new Complex128Vector( buf, 16 );\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( 64 );\n* var arr = new Complex128Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Complex128Vector = factory( 'complex128' );\n\n\n// EXPORTS //\n\nexport default Complex128Vector;\n"],"names":["Complex128Vector","factory"],"mappings":";;yGAuGG,IAACA,EAAmBC,EAAS"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index e10f927..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 6e9f25f2140b8dbebaa8f70d12bcebb850b2e6aa Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 21 May 2026 03:29:33 +0000 Subject: [PATCH 25/37] 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 | 86 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 61 +- 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 | 49 - 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 | 71 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 1024 ---- 45 files changed, 4876 insertions(+), 5395 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 ab9b12f..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2026-05-21T03:22:54.564Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 53d0027..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/complex128) 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 eb573d9..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/complex128) 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 f060126..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: '43 19 * * 2' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 83d50c4..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,821 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send notification to Zulip if job fails: - - name: 'Send notification to Zulip in case of failure' - # Pin action to full length commit SHA - uses: zulip/github-actions-zulip/send-message@e4c8f27c732ba9bd98ac6be0583096dea82feea5 # v1.0.2 - if: failure() - with: - api-key: ${{ secrets.ZULIP_API_KEY }} - email: 'github-actions-bot@stdlib.zulipchat.com' - organization-url: 'https://stdlib.zulipchat.com' - to: 'workflows-standalone' - type: 'stream' - topic: ${{ github.event.repository.name }} - content: | - :cross_mark: **${{ github.workflow }}** workflow failed - - **Repository:** [${{ github.repository }}](${{ github.server_url }}/${{ github.repository }}) - **Run:** [View workflow run](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}) - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -231,7 +222,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]. @@ -294,9 +285,9 @@ Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-vector-complex128/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 be3b5e9..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 Complex128Vector = require( './../lib' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var arr; - var i; - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr = new Complex128Vector( 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 6331119..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 Complex128Vector = 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 Complex128Vector( 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 ec929f5..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/complex128" -%% click B href "https://github.com/stdlib-js/ndarray-vector-complex128/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-vector-complex128/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-vector-complex128/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-vector-complex128/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-vector-complex128/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/vector/complex128 -[production-url]: https://github.com/stdlib-js/ndarray-vector-complex128/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-vector-complex128/tree/deno -[deno-readme]: https://github.com/stdlib-js/ndarray-vector-complex128/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/ndarray-vector-complex128/tree/umd -[umd-readme]: https://github.com/stdlib-js/ndarray-vector-complex128/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/ndarray-vector-complex128/tree/esm -[esm-readme]: https://github.com/stdlib-js/ndarray-vector-complex128/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 063d577..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var a=function(o,r){return function(){return r||o((r={exports:{}}).exports,r),r.exports}};var t=a(function(u,e){ -var c=require('@stdlib/ndarray-vector-ctor/dist').factory,s=c("complex128");e.exports=s -});var i=t();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 bb0a8c7..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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Complex128Vector\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 Complex128Vector();\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 Complex128Vector( 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.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( 64 );\n* var arr = new Complex128Vector( buf );\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( 48 );\n* var arr = new Complex128Vector( buf, 16 );\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( 64 );\n* var arr = new Complex128Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Complex128Vector = factory( 'complex128' );\n\n\n// EXPORTS //\n\nmodule.exports = Complex128Vector;\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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @module @stdlib/ndarray-vector-complex128\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var v = new Complex128Vector();\n* // returns \n*\n* var len = numel( v );\n* // returns 0\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var v = new Complex128Vector( 2 );\n* // returns \n*\n* var len = numel( v );\n* // returns 2\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var v = new Complex128Vector( [ 1.0, 2.0, 3.0, 4.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 Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var buf = new ArrayBuffer( 64 );\n* var v = new Complex128Vector( buf );\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 Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var buf = new ArrayBuffer( 48 );\n* var v = new Complex128Vector( buf, 16 );\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 Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var buf = new ArrayBuffer( 64 );\n* var v = new Complex128Vector( 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,EAAmBD,EAAS,YAAa,EAK7CD,EAAO,QAAUE,ICdjB,IAAIC,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "factory", "Complex128Vector", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 718f62a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,175 +0,0 @@ - -{{alias}}( [options] ) - Returns a one-dimensional double-precision complex 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 double-precision complex 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 double-precision complex 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, 4.0, 5.0, 6.0 ]; - > var arr = {{alias}}( v ) - - > var len = {{alias:@stdlib/ndarray/numel}}( arr ) - 3 - - -{{alias}}( buffer[, byteOffset[, length]][, options] ) - Returns a one-dimensional double-precision complex 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}}( 64 ); - > var arr = {{alias}}( buf, 0, 2 ) - - > var len = {{alias:@stdlib/ndarray/numel}}( arr ) - 2 - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 79a3121..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 Complex128Vector = require( './index' ); - - -// TESTS // - -// The function returns an ndarray... -{ - new Complex128Vector(); // $ExpectType complex128ndarray - new Complex128Vector( {} ); // $ExpectType complex128ndarray - - new Complex128Vector( 10 ); // $ExpectType complex128ndarray - new Complex128Vector( 10, {} ); // $ExpectType complex128ndarray - - new Complex128Vector( [ 1, 2, 3, 4 ] ); // $ExpectType complex128ndarray - new Complex128Vector( [ 1, 2, 3, 4 ], {} ); // $ExpectType complex128ndarray - - new Complex128Vector( new ArrayBuffer( 10 ) ); // $ExpectType complex128ndarray - new Complex128Vector( new ArrayBuffer( 10 ), {} ); // $ExpectType complex128ndarray - - new Complex128Vector( new ArrayBuffer( 10 ), 8 ); // $ExpectType complex128ndarray - new Complex128Vector( new ArrayBuffer( 10 ), 8, {} ); // $ExpectType complex128ndarray - - new Complex128Vector( new ArrayBuffer( 10 ), 8, 0 ); // $ExpectType complex128ndarray - new Complex128Vector( new ArrayBuffer( 10 ), 8, 0, {} ); // $ExpectType complex128ndarray - - const vector = Complex128Vector; - vector(); // $ExpectType complex128ndarray - vector( {} ); // $ExpectType complex128ndarray - - vector( 10 ); // $ExpectType complex128ndarray - vector( 10, {} ); // $ExpectType complex128ndarray - - vector( [ 1, 2, 3, 4 ] ); // $ExpectType complex128ndarray - vector( [ 1, 2, 3, 4 ], {} ); // $ExpectType complex128ndarray - - vector( new ArrayBuffer( 10 ) ); // $ExpectType complex128ndarray - vector( new ArrayBuffer( 10 ), {} ); // $ExpectType complex128ndarray - - vector( new ArrayBuffer( 10 ), 8 ); // $ExpectType complex128ndarray - vector( new ArrayBuffer( 10 ), 8, {} ); // $ExpectType complex128ndarray - - vector( new ArrayBuffer( 10 ), 8, 0 ); // $ExpectType complex128ndarray - vector( new ArrayBuffer( 10 ), 8, 0, {} ); // $ExpectType complex128ndarray -} - -// 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 Complex128Vector( true ); // $ExpectError - new Complex128Vector( false ); // $ExpectError - new Complex128Vector( null ); // $ExpectError - new Complex128Vector( ( x: number ): number => x ); // $ExpectError - - const vector = Complex128Vector; - 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 Complex128Vector( buf, 8, 2, {}, {} ); // $ExpectError - - const vector = Complex128Vector; - vector( buf, 8, 2, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 0cc3779..0000000 --- a/examples/index.js +++ /dev/null @@ -1,49 +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 real = require( '@stdlib/complex-float64-real' ); -var imag = require( '@stdlib/complex-float64-imag' ); -var Complex128 = require( '@stdlib/complex-float64-ctor' ); -var Complex128Vector = require( './../lib' ); - -// Create a vector containing random values: -var x = new Complex128Vector( discreteUniform( 20, 0, 100 ) ); - -// Compute the sum: -var v = sum( x ); -console.log( v.get() ); - -// Define a function which applies a threshold to real and imaginary components: -function threshold( v ) { - if ( real( v ) > 10 && imag( v ) > 10 ) { - return v; - } - return new Complex128( 0.0, 0.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 deda8c2..5a1608e 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -20,7 +20,7 @@ /* eslint-disable @typescript-eslint/unified-signatures */ -/// +/// import { Order, Mode, complex128ndarray } 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..8400946 --- /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 r}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-vector-ctor@v0.1.1-esm/index.mjs";var t=r("complex128");export{t as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..fc76095 --- /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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Complex128Vector\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 Complex128Vector();\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 Complex128Vector( 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.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( 64 );\n* var arr = new Complex128Vector( buf );\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( 48 );\n* var arr = new Complex128Vector( buf, 16 );\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( 64 );\n* var arr = new Complex128Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Complex128Vector = factory( 'complex128' );\n\n\n// EXPORTS //\n\nexport default Complex128Vector;\n"],"names":["Complex128Vector","factory"],"mappings":";;yGAuGG,IAACA,EAAmBC,EAAS"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 872d251..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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray). -* -* @module @stdlib/ndarray-vector-complex128 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var v = new Complex128Vector(); -* // returns -* -* var len = numel( v ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var v = new Complex128Vector( 2 ); -* // returns -* -* var len = numel( v ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var v = new Complex128Vector( [ 1.0, 2.0, 3.0, 4.0 ] ); -* // returns -* -* var len = numel( v ); -* // returns 2 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var buf = new ArrayBuffer( 64 ); -* var v = new Complex128Vector( buf ); -* // returns -* -* var len = numel( v ); -* // returns 4 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var buf = new ArrayBuffer( 48 ); -* var v = new Complex128Vector( buf, 16 ); -* // returns -* -* var len = numel( v ); -* // returns 2 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var buf = new ArrayBuffer( 64 ); -* var v = new Complex128Vector( 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 e9fb219..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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray). -* -* @name Complex128Vector -* @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 Complex128Vector(); -* // returns -* -* var len = numel( arr ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Complex128Vector( 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Complex128Vector( [ 1.0, 2.0, 3.0, 4.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( 64 ); -* var arr = new Complex128Vector( buf ); -* // returns -* -* var len = numel( arr ); -* // returns 4 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 48 ); -* var arr = new Complex128Vector( buf, 16 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 64 ); -* var arr = new Complex128Vector( buf, 16, 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -*/ -var Complex128Vector = factory( 'complex128' ); - - -// EXPORTS // - -module.exports = Complex128Vector; diff --git a/package.json b/package.json index d981c1f..ebe5dcf 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.1", "description": "Create a double-precision complex 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,50 +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-complex128": "^0.3.2", - "@stdlib/array-float32": "^0.2.3", - "@stdlib/assert-is-ndarray-like": "^0.2.3", - "@stdlib/assert-is-ndarray-like-with-data-type": "^0.1.1", - "@stdlib/assert-is-same-complex128array": "^0.2.3", - "@stdlib/blas-ext-sum": "^0.1.1", - "@stdlib/buffer-from-array": "^0.2.3", - "@stdlib/complex-float64-ctor": "^0.1.2", - "@stdlib/complex-float64-imag": "^0.1.2", - "@stdlib/complex-float64-real": "^0.1.2", - "@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..e10f927 --- /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 be638c1..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 isSameComplex128Array = require( '@stdlib/assert-is-same-complex128array' ); -var isReadOnly = require( '@stdlib/ndarray-base-assert-is-read-only' ); -var ArrayBuffer = require( '@stdlib/array-buffer' ); -var Float32Array = require( '@stdlib/array-float32' ); -var Complex128Array = require( '@stdlib/array-complex128' ); -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 Complex128Vector = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof Complex128Vector, '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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( [], 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector({ - '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 Complex128Vector({ - '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 Complex128Vector({ - 'readonly': value - }); - }; - } -}); - -tape( 'the function returns a one-dimensional ndarray', function test( t ) { - var arr; - - arr = new Complex128Vector(); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 0, 'returns expected value' ); - - arr = new Complex128Vector( {} ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( 10 ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 10, 'returns expected value' ); - - arr = new Complex128Vector( 10, {} ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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, 5.0, 6.0, 7.0, 8.0 ]; - - out = new Complex128Vector( arr ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( arr ) ), true, 'returns expected value' ); - - out = new Complex128Vector( arr, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( 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 Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - - out = new Complex128Vector( arr ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( arr ) ), true, 'returns expected value' ); - - out = new Complex128Vector( arr, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( 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, 5, 6, 7, 8 ]; - buf = array2buffer( arr ); - - out = new Complex128Vector( buf ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( arr ) ), true, 'returns expected value' ); - - out = new Complex128Vector( buf, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( 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( 32 ); - - out = new Complex128Vector( buf ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 2, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( buf ) ), true, 'returns expected value' ); - - out = new Complex128Vector( buf, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 2, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( 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( 64 ); - - out = new Complex128Vector( buf, 16 ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 3, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( buf, 16 ) ), true, 'returns expected value' ); - - out = new Complex128Vector( buf, 16, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 3, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( buf, 16 ) ), 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( 64 ); - - out = new Complex128Vector( buf, 16, 2 ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 2, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( buf, 16, 2 ) ), true, 'returns expected value' ); - - out = new Complex128Vector( buf, 16, 2, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 2, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( buf, 16, 2 ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout', function test( t ) { - var arr; - - arr = new Complex128Vector({ - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 0, 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Complex128Vector({ - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( 10, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 10, 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Complex128Vector( 10, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ], { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 4, 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Complex128Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ], { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( new ArrayBuffer( 64 ), { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 4, 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Complex128Vector( new ArrayBuffer( 64 ), { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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, byteoffset)', function test( t ) { - var arr; - - arr = new Complex128Vector( new ArrayBuffer( 64 ), 16, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 3, 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Complex128Vector( new ArrayBuffer( 64 ), 16, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 3, '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 Complex128Vector( new ArrayBuffer( 64 ), 16, 2, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 2, 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Complex128Vector( new ArrayBuffer( 64 ), 16, 2, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector({ - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( 10, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ], { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( new ArrayBuffer( 64 ), { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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, byteoffset)', function test( t ) { - var arr; - - arr = new Complex128Vector( new ArrayBuffer( 64 ), 16, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 3, '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 Complex128Vector( new ArrayBuffer( 64 ), 16, 2, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector({ - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( 10, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ], { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( new ArrayBuffer( 64 ), { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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, byteoffset)', function test( t ) { - var arr; - - arr = new Complex128Vector( new ArrayBuffer( 64 ), 16, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 3, '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 Complex128Vector( new ArrayBuffer( 64 ), 16, 2, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 2, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); From bf175ffed2541a59bf1be067021b02684916b87d Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 1 Jul 2026 03:28:02 +0000 Subject: [PATCH 26/37] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 00b116b..39c7799 100644 --- a/package.json +++ b/package.json @@ -59,7 +59,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 fb51643c40f75f52dd6bc90efc9fd1e6d4534956 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 1 Jul 2026 03:35:38 +0000 Subject: [PATCH 27/37] 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 5a1608e..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, complex128ndarray } 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 Complex128Vector { - /** - * Creates a double-precision complex 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 Complex128Vector(); - * // returns - * - * var len = numel( arr ); - * // returns 0 - */ - new ( options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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 Complex128Vector( 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( length: number, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.0 ] ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( obj: Collection | AccessorArrayLike | Iterable, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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 Complex128Vector( buf ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( buffer: ArrayBuffer, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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( 64 ); - * var arr = new Complex128Vector( buf, 16 ); - * // returns - * - * var len = numel( arr ); - * // returns 3 - */ - new ( buffer: ArrayBuffer, byteOffset: number, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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( 64 ); - * var arr = new Complex128Vector( buf, 16, 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( buffer: ArrayBuffer, byteOffset: number, length: number, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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 Complex128Vector(); - * // returns - * - * var len = numel( arr ); - * // returns 0 - */ - ( options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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 Complex128Vector( 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( length: number, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.0 ] ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( obj: Collection | AccessorArrayLike | Iterable, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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( 64 ); - * var arr = new Complex128Vector( buf ); - * // returns - * - * var len = numel( arr ); - * // returns 4 - */ - ( buffer: ArrayBuffer, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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( 64 ); - * var arr = new Complex128Vector( buf, 16 ); - * // returns - * - * var len = numel( arr ); - * // returns 3 - */ - ( buffer: ArrayBuffer, byteOffset: number, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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( 64 ); - * var arr = new Complex128Vector( buf, 16, 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( buffer: ArrayBuffer, byteOffset: number, length: number, options?: Options ): complex128ndarray; -} - -/** -* Creates a double-precision complex 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 Complex128Vector(); -* // returns -* -* var len = numel( arr ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Complex128Vector( 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Complex128Vector( [ 1.0, 2.0, 3.0, 4.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( 64 ); -* var arr = new Complex128Vector( buf, 16, 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -*/ -declare var ctor: Complex128Vector; - - -// EXPORTS // - -export = ctor; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 8400946..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 r}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-vector-ctor@v0.1.1-esm/index.mjs";var t=r("complex128");export{t as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index fc76095..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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Complex128Vector\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 Complex128Vector();\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 Complex128Vector( 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.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( 64 );\n* var arr = new Complex128Vector( buf );\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( 48 );\n* var arr = new Complex128Vector( buf, 16 );\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( 64 );\n* var arr = new Complex128Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Complex128Vector = factory( 'complex128' );\n\n\n// EXPORTS //\n\nexport default Complex128Vector;\n"],"names":["Complex128Vector","factory"],"mappings":";;yGAuGG,IAACA,EAAmBC,EAAS"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index e10f927..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 1ced8c67dc9009cd3f362da316230cfe7f767883 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 1 Jul 2026 03:36:10 +0000 Subject: [PATCH 28/37] 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 | 86 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 61 +- 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 | 49 - 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 | 71 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 1024 ---- 45 files changed, 4876 insertions(+), 5395 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 91edfa8..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2026-07-01T03:26:26.959Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 53d0027..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/complex128) 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 eb573d9..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/complex128) 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 f060126..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: '43 19 * * 2' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 83d50c4..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,821 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send notification to Zulip if job fails: - - name: 'Send notification to Zulip in case of failure' - # Pin action to full length commit SHA - uses: zulip/github-actions-zulip/send-message@e4c8f27c732ba9bd98ac6be0583096dea82feea5 # v1.0.2 - if: failure() - with: - api-key: ${{ secrets.ZULIP_API_KEY }} - email: 'github-actions-bot@stdlib.zulipchat.com' - organization-url: 'https://stdlib.zulipchat.com' - to: 'workflows-standalone' - type: 'stream' - topic: ${{ github.event.repository.name }} - content: | - :cross_mark: **${{ github.workflow }}** workflow failed - - **Repository:** [${{ github.repository }}](${{ github.server_url }}/${{ github.repository }}) - **Run:** [View workflow run](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}) - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -231,7 +222,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]. @@ -294,9 +285,9 @@ Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-vector-complex128/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 be3b5e9..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 Complex128Vector = require( './../lib' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var arr; - var i; - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr = new Complex128Vector( 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 6331119..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 Complex128Vector = 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 Complex128Vector( 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 ec929f5..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/complex128" -%% click B href "https://github.com/stdlib-js/ndarray-vector-complex128/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-vector-complex128/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-vector-complex128/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-vector-complex128/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-vector-complex128/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/vector/complex128 -[production-url]: https://github.com/stdlib-js/ndarray-vector-complex128/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-vector-complex128/tree/deno -[deno-readme]: https://github.com/stdlib-js/ndarray-vector-complex128/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/ndarray-vector-complex128/tree/umd -[umd-readme]: https://github.com/stdlib-js/ndarray-vector-complex128/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/ndarray-vector-complex128/tree/esm -[esm-readme]: https://github.com/stdlib-js/ndarray-vector-complex128/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 19ed956..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var c=function(o,r){return function(){try{return r||o((r={exports:{}}).exports,r),r.exports}catch(a){throw (r=0, a)}};};var t=c(function(x,e){ -var s=require('@stdlib/ndarray-vector-ctor/dist').factory,i=s("complex128");e.exports=i -});var p=t();module.exports=p; -/** @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 7fc3136..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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Complex128Vector\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 Complex128Vector();\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 Complex128Vector( 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.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( 64 );\n* var arr = new Complex128Vector( buf );\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( 48 );\n* var arr = new Complex128Vector( buf, 16 );\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( 64 );\n* var arr = new Complex128Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Complex128Vector = factory( 'complex128' );\n\n\n// EXPORTS //\n\nmodule.exports = Complex128Vector;\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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @module @stdlib/ndarray-vector-complex128\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var v = new Complex128Vector();\n* // returns \n*\n* var len = numel( v );\n* // returns 0\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var v = new Complex128Vector( 2 );\n* // returns \n*\n* var len = numel( v );\n* // returns 2\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var v = new Complex128Vector( [ 1.0, 2.0, 3.0, 4.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 Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var buf = new ArrayBuffer( 64 );\n* var v = new Complex128Vector( buf );\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 Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var buf = new ArrayBuffer( 48 );\n* var v = new Complex128Vector( buf, 16 );\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 Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var buf = new ArrayBuffer( 64 );\n* var v = new Complex128Vector( 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": "iIAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,QAAS,6BAA8B,EAAE,QAiFnDC,EAAmBD,EAAS,YAAa,EAK7CD,EAAO,QAAUE,ICdjB,IAAIC,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "factory", "Complex128Vector", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 718f62a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,175 +0,0 @@ - -{{alias}}( [options] ) - Returns a one-dimensional double-precision complex 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 double-precision complex 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 double-precision complex 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, 4.0, 5.0, 6.0 ]; - > var arr = {{alias}}( v ) - - > var len = {{alias:@stdlib/ndarray/numel}}( arr ) - 3 - - -{{alias}}( buffer[, byteOffset[, length]][, options] ) - Returns a one-dimensional double-precision complex 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}}( 64 ); - > var arr = {{alias}}( buf, 0, 2 ) - - > var len = {{alias:@stdlib/ndarray/numel}}( arr ) - 2 - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 79a3121..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 Complex128Vector = require( './index' ); - - -// TESTS // - -// The function returns an ndarray... -{ - new Complex128Vector(); // $ExpectType complex128ndarray - new Complex128Vector( {} ); // $ExpectType complex128ndarray - - new Complex128Vector( 10 ); // $ExpectType complex128ndarray - new Complex128Vector( 10, {} ); // $ExpectType complex128ndarray - - new Complex128Vector( [ 1, 2, 3, 4 ] ); // $ExpectType complex128ndarray - new Complex128Vector( [ 1, 2, 3, 4 ], {} ); // $ExpectType complex128ndarray - - new Complex128Vector( new ArrayBuffer( 10 ) ); // $ExpectType complex128ndarray - new Complex128Vector( new ArrayBuffer( 10 ), {} ); // $ExpectType complex128ndarray - - new Complex128Vector( new ArrayBuffer( 10 ), 8 ); // $ExpectType complex128ndarray - new Complex128Vector( new ArrayBuffer( 10 ), 8, {} ); // $ExpectType complex128ndarray - - new Complex128Vector( new ArrayBuffer( 10 ), 8, 0 ); // $ExpectType complex128ndarray - new Complex128Vector( new ArrayBuffer( 10 ), 8, 0, {} ); // $ExpectType complex128ndarray - - const vector = Complex128Vector; - vector(); // $ExpectType complex128ndarray - vector( {} ); // $ExpectType complex128ndarray - - vector( 10 ); // $ExpectType complex128ndarray - vector( 10, {} ); // $ExpectType complex128ndarray - - vector( [ 1, 2, 3, 4 ] ); // $ExpectType complex128ndarray - vector( [ 1, 2, 3, 4 ], {} ); // $ExpectType complex128ndarray - - vector( new ArrayBuffer( 10 ) ); // $ExpectType complex128ndarray - vector( new ArrayBuffer( 10 ), {} ); // $ExpectType complex128ndarray - - vector( new ArrayBuffer( 10 ), 8 ); // $ExpectType complex128ndarray - vector( new ArrayBuffer( 10 ), 8, {} ); // $ExpectType complex128ndarray - - vector( new ArrayBuffer( 10 ), 8, 0 ); // $ExpectType complex128ndarray - vector( new ArrayBuffer( 10 ), 8, 0, {} ); // $ExpectType complex128ndarray -} - -// 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 Complex128Vector( true ); // $ExpectError - new Complex128Vector( false ); // $ExpectError - new Complex128Vector( null ); // $ExpectError - new Complex128Vector( ( x: number ): number => x ); // $ExpectError - - const vector = Complex128Vector; - 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 Complex128Vector( buf, 8, 2, {}, {} ); // $ExpectError - - const vector = Complex128Vector; - vector( buf, 8, 2, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 0cc3779..0000000 --- a/examples/index.js +++ /dev/null @@ -1,49 +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 real = require( '@stdlib/complex-float64-real' ); -var imag = require( '@stdlib/complex-float64-imag' ); -var Complex128 = require( '@stdlib/complex-float64-ctor' ); -var Complex128Vector = require( './../lib' ); - -// Create a vector containing random values: -var x = new Complex128Vector( discreteUniform( 20, 0, 100 ) ); - -// Compute the sum: -var v = sum( x ); -console.log( v.get() ); - -// Define a function which applies a threshold to real and imaginary components: -function threshold( v ) { - if ( real( v ) > 10 && imag( v ) > 10 ) { - return v; - } - return new Complex128( 0.0, 0.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 deda8c2..5a1608e 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -20,7 +20,7 @@ /* eslint-disable @typescript-eslint/unified-signatures */ -/// +/// import { Order, Mode, complex128ndarray } 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..8400946 --- /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 r}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-vector-ctor@v0.1.1-esm/index.mjs";var t=r("complex128");export{t as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..fc76095 --- /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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Complex128Vector\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 Complex128Vector();\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 Complex128Vector( 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.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( 64 );\n* var arr = new Complex128Vector( buf );\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( 48 );\n* var arr = new Complex128Vector( buf, 16 );\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( 64 );\n* var arr = new Complex128Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Complex128Vector = factory( 'complex128' );\n\n\n// EXPORTS //\n\nexport default Complex128Vector;\n"],"names":["Complex128Vector","factory"],"mappings":";;yGAuGG,IAACA,EAAmBC,EAAS"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 872d251..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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray). -* -* @module @stdlib/ndarray-vector-complex128 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var v = new Complex128Vector(); -* // returns -* -* var len = numel( v ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var v = new Complex128Vector( 2 ); -* // returns -* -* var len = numel( v ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var v = new Complex128Vector( [ 1.0, 2.0, 3.0, 4.0 ] ); -* // returns -* -* var len = numel( v ); -* // returns 2 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var buf = new ArrayBuffer( 64 ); -* var v = new Complex128Vector( buf ); -* // returns -* -* var len = numel( v ); -* // returns 4 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var buf = new ArrayBuffer( 48 ); -* var v = new Complex128Vector( buf, 16 ); -* // returns -* -* var len = numel( v ); -* // returns 2 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var buf = new ArrayBuffer( 64 ); -* var v = new Complex128Vector( 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 e9fb219..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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray). -* -* @name Complex128Vector -* @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 Complex128Vector(); -* // returns -* -* var len = numel( arr ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Complex128Vector( 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Complex128Vector( [ 1.0, 2.0, 3.0, 4.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( 64 ); -* var arr = new Complex128Vector( buf ); -* // returns -* -* var len = numel( arr ); -* // returns 4 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 48 ); -* var arr = new Complex128Vector( buf, 16 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 64 ); -* var arr = new Complex128Vector( buf, 16, 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -*/ -var Complex128Vector = factory( 'complex128' ); - - -// EXPORTS // - -module.exports = Complex128Vector; diff --git a/package.json b/package.json index 39c7799..ebe5dcf 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.1", "description": "Create a double-precision complex 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,50 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/ndarray-vector-ctor": "^0.1.1", - "@stdlib/types": "^0.5.1" - }, - "devDependencies": { - "@stdlib/array-buffer": "^0.2.3", - "@stdlib/array-complex128": "^0.3.2", - "@stdlib/array-float32": "^0.2.3", - "@stdlib/assert-is-ndarray-like": "^0.2.3", - "@stdlib/assert-is-ndarray-like-with-data-type": "^0.1.1", - "@stdlib/assert-is-same-complex128array": "^0.2.3", - "@stdlib/blas-ext-sum": "^0.1.1", - "@stdlib/buffer-from-array": "^0.2.3", - "@stdlib/complex-float64-ctor": "^0.1.2", - "@stdlib/complex-float64-imag": "^0.1.2", - "@stdlib/complex-float64-real": "^0.1.2", - "@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..e10f927 --- /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 be638c1..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 isSameComplex128Array = require( '@stdlib/assert-is-same-complex128array' ); -var isReadOnly = require( '@stdlib/ndarray-base-assert-is-read-only' ); -var ArrayBuffer = require( '@stdlib/array-buffer' ); -var Float32Array = require( '@stdlib/array-float32' ); -var Complex128Array = require( '@stdlib/array-complex128' ); -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 Complex128Vector = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof Complex128Vector, '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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( [], 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector({ - '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 Complex128Vector({ - '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 Complex128Vector({ - 'readonly': value - }); - }; - } -}); - -tape( 'the function returns a one-dimensional ndarray', function test( t ) { - var arr; - - arr = new Complex128Vector(); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 0, 'returns expected value' ); - - arr = new Complex128Vector( {} ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( 10 ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 10, 'returns expected value' ); - - arr = new Complex128Vector( 10, {} ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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, 5.0, 6.0, 7.0, 8.0 ]; - - out = new Complex128Vector( arr ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( arr ) ), true, 'returns expected value' ); - - out = new Complex128Vector( arr, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( 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 Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - - out = new Complex128Vector( arr ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( arr ) ), true, 'returns expected value' ); - - out = new Complex128Vector( arr, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( 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, 5, 6, 7, 8 ]; - buf = array2buffer( arr ); - - out = new Complex128Vector( buf ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( arr ) ), true, 'returns expected value' ); - - out = new Complex128Vector( buf, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( 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( 32 ); - - out = new Complex128Vector( buf ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 2, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( buf ) ), true, 'returns expected value' ); - - out = new Complex128Vector( buf, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 2, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( 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( 64 ); - - out = new Complex128Vector( buf, 16 ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 3, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( buf, 16 ) ), true, 'returns expected value' ); - - out = new Complex128Vector( buf, 16, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 3, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( buf, 16 ) ), 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( 64 ); - - out = new Complex128Vector( buf, 16, 2 ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 2, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( buf, 16, 2 ) ), true, 'returns expected value' ); - - out = new Complex128Vector( buf, 16, 2, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 2, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( buf, 16, 2 ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout', function test( t ) { - var arr; - - arr = new Complex128Vector({ - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 0, 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Complex128Vector({ - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( 10, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 10, 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Complex128Vector( 10, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ], { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 4, 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Complex128Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ], { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( new ArrayBuffer( 64 ), { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 4, 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Complex128Vector( new ArrayBuffer( 64 ), { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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, byteoffset)', function test( t ) { - var arr; - - arr = new Complex128Vector( new ArrayBuffer( 64 ), 16, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 3, 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Complex128Vector( new ArrayBuffer( 64 ), 16, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 3, '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 Complex128Vector( new ArrayBuffer( 64 ), 16, 2, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 2, 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Complex128Vector( new ArrayBuffer( 64 ), 16, 2, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector({ - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( 10, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ], { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( new ArrayBuffer( 64 ), { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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, byteoffset)', function test( t ) { - var arr; - - arr = new Complex128Vector( new ArrayBuffer( 64 ), 16, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 3, '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 Complex128Vector( new ArrayBuffer( 64 ), 16, 2, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector({ - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( 10, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ], { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( new ArrayBuffer( 64 ), { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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, byteoffset)', function test( t ) { - var arr; - - arr = new Complex128Vector( new ArrayBuffer( 64 ), 16, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 3, '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 Complex128Vector( new ArrayBuffer( 64 ), 16, 2, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 2, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); From d061490d34bb46fa6f0eed0178f2db07a71b0e0f Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 8 Aug 2026 03:19:22 +0000 Subject: [PATCH 29/37] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 00b116b..39c7799 100644 --- a/package.json +++ b/package.json @@ -59,7 +59,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 39878dc43b0d76b2f84d028a5080e41aeb69f325 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 8 Aug 2026 03:51:50 +0000 Subject: [PATCH 30/37] 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 5a1608e..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, complex128ndarray } 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 Complex128Vector { - /** - * Creates a double-precision complex 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 Complex128Vector(); - * // returns - * - * var len = numel( arr ); - * // returns 0 - */ - new ( options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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 Complex128Vector( 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( length: number, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.0 ] ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( obj: Collection | AccessorArrayLike | Iterable, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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 Complex128Vector( buf ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( buffer: ArrayBuffer, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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( 64 ); - * var arr = new Complex128Vector( buf, 16 ); - * // returns - * - * var len = numel( arr ); - * // returns 3 - */ - new ( buffer: ArrayBuffer, byteOffset: number, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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( 64 ); - * var arr = new Complex128Vector( buf, 16, 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( buffer: ArrayBuffer, byteOffset: number, length: number, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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 Complex128Vector(); - * // returns - * - * var len = numel( arr ); - * // returns 0 - */ - ( options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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 Complex128Vector( 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( length: number, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.0 ] ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( obj: Collection | AccessorArrayLike | Iterable, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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( 64 ); - * var arr = new Complex128Vector( buf ); - * // returns - * - * var len = numel( arr ); - * // returns 4 - */ - ( buffer: ArrayBuffer, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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( 64 ); - * var arr = new Complex128Vector( buf, 16 ); - * // returns - * - * var len = numel( arr ); - * // returns 3 - */ - ( buffer: ArrayBuffer, byteOffset: number, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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( 64 ); - * var arr = new Complex128Vector( buf, 16, 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( buffer: ArrayBuffer, byteOffset: number, length: number, options?: Options ): complex128ndarray; -} - -/** -* Creates a double-precision complex 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 Complex128Vector(); -* // returns -* -* var len = numel( arr ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Complex128Vector( 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Complex128Vector( [ 1.0, 2.0, 3.0, 4.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( 64 ); -* var arr = new Complex128Vector( buf, 16, 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -*/ -declare var ctor: Complex128Vector; - - -// EXPORTS // - -export = ctor; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 8400946..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 r}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-vector-ctor@v0.1.1-esm/index.mjs";var t=r("complex128");export{t as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index fc76095..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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Complex128Vector\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 Complex128Vector();\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 Complex128Vector( 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.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( 64 );\n* var arr = new Complex128Vector( buf );\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( 48 );\n* var arr = new Complex128Vector( buf, 16 );\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( 64 );\n* var arr = new Complex128Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Complex128Vector = factory( 'complex128' );\n\n\n// EXPORTS //\n\nexport default Complex128Vector;\n"],"names":["Complex128Vector","factory"],"mappings":";;yGAuGG,IAACA,EAAmBC,EAAS"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index e10f927..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From a1b3e94b098cc1d98b8399da538afa2f1cbb4d72 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 8 Aug 2026 03:52:46 +0000 Subject: [PATCH 31/37] Auto-generated commit --- .editorconfig | 189 - .eslintrc.js | 1 - .gitattributes | 68 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 821 --- .github/workflows/publish.yml | 261 - .github/workflows/test.yml | 101 - .github/workflows/test_bundles.yml | 213 - .github/workflows/test_coverage.yml | 142 - .github/workflows/test_install.yml | 94 - .github/workflows/test_published_package.yml | 115 - .gitignore | 204 - .npmignore | 229 - .npmrc | 44 - CHANGELOG.md | 87 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 87 +- 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 | 49 - 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 | 71 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 1024 ---- 44 files changed, 4889 insertions(+), 5408 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 53d0027..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/complex128) 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 eb573d9..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/complex128) 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 f060126..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: '43 19 * * 2' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 83d50c4..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,821 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send notification to Zulip if job fails: - - name: 'Send notification to Zulip in case of failure' - # Pin action to full length commit SHA - uses: zulip/github-actions-zulip/send-message@e4c8f27c732ba9bd98ac6be0583096dea82feea5 # v1.0.2 - if: failure() - with: - api-key: ${{ secrets.ZULIP_API_KEY }} - email: 'github-actions-bot@stdlib.zulipchat.com' - organization-url: 'https://stdlib.zulipchat.com' - to: 'workflows-standalone' - type: 'stream' - topic: ${{ github.event.repository.name }} - content: | - :cross_mark: **${{ github.workflow }}** workflow failed - - **Repository:** [${{ github.repository }}](${{ github.server_url }}/${{ github.repository }}) - **Run:** [View workflow run](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}) - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -250,7 +241,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]. @@ -313,37 +304,37 @@ Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-vector-complex128/main/LICENSE -[@stdlib/array/buffer]: https://github.com/stdlib-js/array-buffer +[@stdlib/array/buffer]: https://github.com/stdlib-js/array-buffer/tree/esm -[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor +[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor/tree/esm -[@stdlib/ndarray/matrix/complex128]: https://github.com/stdlib-js/ndarray-matrix-complex128 +[@stdlib/ndarray/matrix/complex128]: https://github.com/stdlib-js/ndarray-matrix-complex128/tree/esm -[@stdlib/ndarray/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/float32]: https://github.com/stdlib-js/ndarray-vector-float32 +[@stdlib/ndarray/vector/float32]: https://github.com/stdlib-js/ndarray-vector-float32/tree/esm -[@stdlib/ndarray/vector/int16]: https://github.com/stdlib-js/ndarray-vector-int16 +[@stdlib/ndarray/vector/int16]: https://github.com/stdlib-js/ndarray-vector-int16/tree/esm -[@stdlib/ndarray/vector/int32]: https://github.com/stdlib-js/ndarray-vector-int32 +[@stdlib/ndarray/vector/int32]: https://github.com/stdlib-js/ndarray-vector-int32/tree/esm -[@stdlib/ndarray/vector/int8]: https://github.com/stdlib-js/ndarray-vector-int8 +[@stdlib/ndarray/vector/int8]: https://github.com/stdlib-js/ndarray-vector-int8/tree/esm -[@stdlib/ndarray/vector/uint16]: https://github.com/stdlib-js/ndarray-vector-uint16 +[@stdlib/ndarray/vector/uint16]: https://github.com/stdlib-js/ndarray-vector-uint16/tree/esm -[@stdlib/ndarray/vector/uint32]: https://github.com/stdlib-js/ndarray-vector-uint32 +[@stdlib/ndarray/vector/uint32]: https://github.com/stdlib-js/ndarray-vector-uint32/tree/esm -[@stdlib/ndarray/vector/uint8]: https://github.com/stdlib-js/ndarray-vector-uint8 +[@stdlib/ndarray/vector/uint8]: https://github.com/stdlib-js/ndarray-vector-uint8/tree/esm -[@stdlib/ndarray/vector/uint8c]: https://github.com/stdlib-js/ndarray-vector-uint8c +[@stdlib/ndarray/vector/uint8c]: https://github.com/stdlib-js/ndarray-vector-uint8c/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/bool]: https://github.com/stdlib-js/ndarray-vector-bool +[@stdlib/ndarray/vector/bool]: https://github.com/stdlib-js/ndarray-vector-bool/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 be3b5e9..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 Complex128Vector = require( './../lib' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var arr; - var i; - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr = new Complex128Vector( 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 6331119..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 Complex128Vector = 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 Complex128Vector( 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 ec929f5..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/complex128" -%% click B href "https://github.com/stdlib-js/ndarray-vector-complex128/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-vector-complex128/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-vector-complex128/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-vector-complex128/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-vector-complex128/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/vector/complex128 -[production-url]: https://github.com/stdlib-js/ndarray-vector-complex128/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-vector-complex128/tree/deno -[deno-readme]: https://github.com/stdlib-js/ndarray-vector-complex128/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/ndarray-vector-complex128/tree/umd -[umd-readme]: https://github.com/stdlib-js/ndarray-vector-complex128/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/ndarray-vector-complex128/tree/esm -[esm-readme]: https://github.com/stdlib-js/ndarray-vector-complex128/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 19ed956..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var c=function(o,r){return function(){try{return r||o((r={exports:{}}).exports,r),r.exports}catch(a){throw (r=0, a)}};};var t=c(function(x,e){ -var s=require('@stdlib/ndarray-vector-ctor/dist').factory,i=s("complex128");e.exports=i -});var p=t();module.exports=p; -/** @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 7fc3136..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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Complex128Vector\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 Complex128Vector();\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 Complex128Vector( 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.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( 64 );\n* var arr = new Complex128Vector( buf );\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( 48 );\n* var arr = new Complex128Vector( buf, 16 );\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( 64 );\n* var arr = new Complex128Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Complex128Vector = factory( 'complex128' );\n\n\n// EXPORTS //\n\nmodule.exports = Complex128Vector;\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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @module @stdlib/ndarray-vector-complex128\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var v = new Complex128Vector();\n* // returns \n*\n* var len = numel( v );\n* // returns 0\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var v = new Complex128Vector( 2 );\n* // returns \n*\n* var len = numel( v );\n* // returns 2\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var v = new Complex128Vector( [ 1.0, 2.0, 3.0, 4.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 Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var buf = new ArrayBuffer( 64 );\n* var v = new Complex128Vector( buf );\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 Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var buf = new ArrayBuffer( 48 );\n* var v = new Complex128Vector( buf, 16 );\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 Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var buf = new ArrayBuffer( 64 );\n* var v = new Complex128Vector( 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": "iIAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,QAAS,6BAA8B,EAAE,QAiFnDC,EAAmBD,EAAS,YAAa,EAK7CD,EAAO,QAAUE,ICdjB,IAAIC,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "factory", "Complex128Vector", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 718f62a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,175 +0,0 @@ - -{{alias}}( [options] ) - Returns a one-dimensional double-precision complex 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 double-precision complex 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 double-precision complex 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, 4.0, 5.0, 6.0 ]; - > var arr = {{alias}}( v ) - - > var len = {{alias:@stdlib/ndarray/numel}}( arr ) - 3 - - -{{alias}}( buffer[, byteOffset[, length]][, options] ) - Returns a one-dimensional double-precision complex 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}}( 64 ); - > var arr = {{alias}}( buf, 0, 2 ) - - > var len = {{alias:@stdlib/ndarray/numel}}( arr ) - 2 - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 79a3121..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 Complex128Vector = require( './index' ); - - -// TESTS // - -// The function returns an ndarray... -{ - new Complex128Vector(); // $ExpectType complex128ndarray - new Complex128Vector( {} ); // $ExpectType complex128ndarray - - new Complex128Vector( 10 ); // $ExpectType complex128ndarray - new Complex128Vector( 10, {} ); // $ExpectType complex128ndarray - - new Complex128Vector( [ 1, 2, 3, 4 ] ); // $ExpectType complex128ndarray - new Complex128Vector( [ 1, 2, 3, 4 ], {} ); // $ExpectType complex128ndarray - - new Complex128Vector( new ArrayBuffer( 10 ) ); // $ExpectType complex128ndarray - new Complex128Vector( new ArrayBuffer( 10 ), {} ); // $ExpectType complex128ndarray - - new Complex128Vector( new ArrayBuffer( 10 ), 8 ); // $ExpectType complex128ndarray - new Complex128Vector( new ArrayBuffer( 10 ), 8, {} ); // $ExpectType complex128ndarray - - new Complex128Vector( new ArrayBuffer( 10 ), 8, 0 ); // $ExpectType complex128ndarray - new Complex128Vector( new ArrayBuffer( 10 ), 8, 0, {} ); // $ExpectType complex128ndarray - - const vector = Complex128Vector; - vector(); // $ExpectType complex128ndarray - vector( {} ); // $ExpectType complex128ndarray - - vector( 10 ); // $ExpectType complex128ndarray - vector( 10, {} ); // $ExpectType complex128ndarray - - vector( [ 1, 2, 3, 4 ] ); // $ExpectType complex128ndarray - vector( [ 1, 2, 3, 4 ], {} ); // $ExpectType complex128ndarray - - vector( new ArrayBuffer( 10 ) ); // $ExpectType complex128ndarray - vector( new ArrayBuffer( 10 ), {} ); // $ExpectType complex128ndarray - - vector( new ArrayBuffer( 10 ), 8 ); // $ExpectType complex128ndarray - vector( new ArrayBuffer( 10 ), 8, {} ); // $ExpectType complex128ndarray - - vector( new ArrayBuffer( 10 ), 8, 0 ); // $ExpectType complex128ndarray - vector( new ArrayBuffer( 10 ), 8, 0, {} ); // $ExpectType complex128ndarray -} - -// 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 Complex128Vector( true ); // $ExpectError - new Complex128Vector( false ); // $ExpectError - new Complex128Vector( null ); // $ExpectError - new Complex128Vector( ( x: number ): number => x ); // $ExpectError - - const vector = Complex128Vector; - 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 Complex128Vector( buf, 8, 2, {}, {} ); // $ExpectError - - const vector = Complex128Vector; - vector( buf, 8, 2, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 0cc3779..0000000 --- a/examples/index.js +++ /dev/null @@ -1,49 +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 real = require( '@stdlib/complex-float64-real' ); -var imag = require( '@stdlib/complex-float64-imag' ); -var Complex128 = require( '@stdlib/complex-float64-ctor' ); -var Complex128Vector = require( './../lib' ); - -// Create a vector containing random values: -var x = new Complex128Vector( discreteUniform( 20, 0, 100 ) ); - -// Compute the sum: -var v = sum( x ); -console.log( v.get() ); - -// Define a function which applies a threshold to real and imaginary components: -function threshold( v ) { - if ( real( v ) > 10 && imag( v ) > 10 ) { - return v; - } - return new Complex128( 0.0, 0.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 deda8c2..5a1608e 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -20,7 +20,7 @@ /* eslint-disable @typescript-eslint/unified-signatures */ -/// +/// import { Order, Mode, complex128ndarray } 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..8400946 --- /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 r}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-vector-ctor@v0.1.1-esm/index.mjs";var t=r("complex128");export{t as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..fc76095 --- /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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Complex128Vector\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 Complex128Vector();\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 Complex128Vector( 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.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( 64 );\n* var arr = new Complex128Vector( buf );\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( 48 );\n* var arr = new Complex128Vector( buf, 16 );\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( 64 );\n* var arr = new Complex128Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Complex128Vector = factory( 'complex128' );\n\n\n// EXPORTS //\n\nexport default Complex128Vector;\n"],"names":["Complex128Vector","factory"],"mappings":";;yGAuGG,IAACA,EAAmBC,EAAS"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 872d251..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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray). -* -* @module @stdlib/ndarray-vector-complex128 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var v = new Complex128Vector(); -* // returns -* -* var len = numel( v ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var v = new Complex128Vector( 2 ); -* // returns -* -* var len = numel( v ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var v = new Complex128Vector( [ 1.0, 2.0, 3.0, 4.0 ] ); -* // returns -* -* var len = numel( v ); -* // returns 2 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var buf = new ArrayBuffer( 64 ); -* var v = new Complex128Vector( buf ); -* // returns -* -* var len = numel( v ); -* // returns 4 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var buf = new ArrayBuffer( 48 ); -* var v = new Complex128Vector( buf, 16 ); -* // returns -* -* var len = numel( v ); -* // returns 2 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var buf = new ArrayBuffer( 64 ); -* var v = new Complex128Vector( 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 e9fb219..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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray). -* -* @name Complex128Vector -* @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 Complex128Vector(); -* // returns -* -* var len = numel( arr ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Complex128Vector( 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Complex128Vector( [ 1.0, 2.0, 3.0, 4.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( 64 ); -* var arr = new Complex128Vector( buf ); -* // returns -* -* var len = numel( arr ); -* // returns 4 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 48 ); -* var arr = new Complex128Vector( buf, 16 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 64 ); -* var arr = new Complex128Vector( buf, 16, 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -*/ -var Complex128Vector = factory( 'complex128' ); - - -// EXPORTS // - -module.exports = Complex128Vector; diff --git a/package.json b/package.json index 39c7799..ebe5dcf 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.1", "description": "Create a double-precision complex 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,50 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/ndarray-vector-ctor": "^0.1.1", - "@stdlib/types": "^0.5.1" - }, - "devDependencies": { - "@stdlib/array-buffer": "^0.2.3", - "@stdlib/array-complex128": "^0.3.2", - "@stdlib/array-float32": "^0.2.3", - "@stdlib/assert-is-ndarray-like": "^0.2.3", - "@stdlib/assert-is-ndarray-like-with-data-type": "^0.1.1", - "@stdlib/assert-is-same-complex128array": "^0.2.3", - "@stdlib/blas-ext-sum": "^0.1.1", - "@stdlib/buffer-from-array": "^0.2.3", - "@stdlib/complex-float64-ctor": "^0.1.2", - "@stdlib/complex-float64-imag": "^0.1.2", - "@stdlib/complex-float64-real": "^0.1.2", - "@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..e10f927 --- /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 be638c1..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 isSameComplex128Array = require( '@stdlib/assert-is-same-complex128array' ); -var isReadOnly = require( '@stdlib/ndarray-base-assert-is-read-only' ); -var ArrayBuffer = require( '@stdlib/array-buffer' ); -var Float32Array = require( '@stdlib/array-float32' ); -var Complex128Array = require( '@stdlib/array-complex128' ); -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 Complex128Vector = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof Complex128Vector, '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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( [], 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector({ - '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 Complex128Vector({ - '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 Complex128Vector({ - 'readonly': value - }); - }; - } -}); - -tape( 'the function returns a one-dimensional ndarray', function test( t ) { - var arr; - - arr = new Complex128Vector(); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 0, 'returns expected value' ); - - arr = new Complex128Vector( {} ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( 10 ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 10, 'returns expected value' ); - - arr = new Complex128Vector( 10, {} ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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, 5.0, 6.0, 7.0, 8.0 ]; - - out = new Complex128Vector( arr ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( arr ) ), true, 'returns expected value' ); - - out = new Complex128Vector( arr, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( 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 Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - - out = new Complex128Vector( arr ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( arr ) ), true, 'returns expected value' ); - - out = new Complex128Vector( arr, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( 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, 5, 6, 7, 8 ]; - buf = array2buffer( arr ); - - out = new Complex128Vector( buf ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( arr ) ), true, 'returns expected value' ); - - out = new Complex128Vector( buf, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( 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( 32 ); - - out = new Complex128Vector( buf ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 2, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( buf ) ), true, 'returns expected value' ); - - out = new Complex128Vector( buf, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 2, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( 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( 64 ); - - out = new Complex128Vector( buf, 16 ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 3, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( buf, 16 ) ), true, 'returns expected value' ); - - out = new Complex128Vector( buf, 16, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 3, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( buf, 16 ) ), 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( 64 ); - - out = new Complex128Vector( buf, 16, 2 ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 2, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( buf, 16, 2 ) ), true, 'returns expected value' ); - - out = new Complex128Vector( buf, 16, 2, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 2, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( buf, 16, 2 ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout', function test( t ) { - var arr; - - arr = new Complex128Vector({ - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 0, 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Complex128Vector({ - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( 10, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 10, 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Complex128Vector( 10, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ], { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 4, 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Complex128Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ], { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( new ArrayBuffer( 64 ), { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 4, 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Complex128Vector( new ArrayBuffer( 64 ), { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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, byteoffset)', function test( t ) { - var arr; - - arr = new Complex128Vector( new ArrayBuffer( 64 ), 16, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 3, 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Complex128Vector( new ArrayBuffer( 64 ), 16, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 3, '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 Complex128Vector( new ArrayBuffer( 64 ), 16, 2, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 2, 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Complex128Vector( new ArrayBuffer( 64 ), 16, 2, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector({ - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( 10, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ], { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( new ArrayBuffer( 64 ), { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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, byteoffset)', function test( t ) { - var arr; - - arr = new Complex128Vector( new ArrayBuffer( 64 ), 16, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 3, '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 Complex128Vector( new ArrayBuffer( 64 ), 16, 2, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector({ - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( 10, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ], { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( new ArrayBuffer( 64 ), { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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, byteoffset)', function test( t ) { - var arr; - - arr = new Complex128Vector( new ArrayBuffer( 64 ), 16, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 3, '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 Complex128Vector( new ArrayBuffer( 64 ), 16, 2, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 2, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); From 59a5b1a42ee57aa2b3e2dcdbbd4e354713f202d6 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 19 Aug 2026 03:22:27 +0000 Subject: [PATCH 32/37] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 00b116b..39c7799 100644 --- a/package.json +++ b/package.json @@ -59,7 +59,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 ca8a54b438d7d709f62e6d998514e5e2a18a25bb Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 19 Aug 2026 03:42:07 +0000 Subject: [PATCH 33/37] 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 5a1608e..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, complex128ndarray } 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 Complex128Vector { - /** - * Creates a double-precision complex 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 Complex128Vector(); - * // returns - * - * var len = numel( arr ); - * // returns 0 - */ - new ( options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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 Complex128Vector( 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( length: number, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.0 ] ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( obj: Collection | AccessorArrayLike | Iterable, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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 Complex128Vector( buf ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( buffer: ArrayBuffer, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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( 64 ); - * var arr = new Complex128Vector( buf, 16 ); - * // returns - * - * var len = numel( arr ); - * // returns 3 - */ - new ( buffer: ArrayBuffer, byteOffset: number, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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( 64 ); - * var arr = new Complex128Vector( buf, 16, 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( buffer: ArrayBuffer, byteOffset: number, length: number, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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 Complex128Vector(); - * // returns - * - * var len = numel( arr ); - * // returns 0 - */ - ( options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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 Complex128Vector( 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( length: number, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.0 ] ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( obj: Collection | AccessorArrayLike | Iterable, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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( 64 ); - * var arr = new Complex128Vector( buf ); - * // returns - * - * var len = numel( arr ); - * // returns 4 - */ - ( buffer: ArrayBuffer, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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( 64 ); - * var arr = new Complex128Vector( buf, 16 ); - * // returns - * - * var len = numel( arr ); - * // returns 3 - */ - ( buffer: ArrayBuffer, byteOffset: number, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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( 64 ); - * var arr = new Complex128Vector( buf, 16, 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( buffer: ArrayBuffer, byteOffset: number, length: number, options?: Options ): complex128ndarray; -} - -/** -* Creates a double-precision complex 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 Complex128Vector(); -* // returns -* -* var len = numel( arr ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Complex128Vector( 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Complex128Vector( [ 1.0, 2.0, 3.0, 4.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( 64 ); -* var arr = new Complex128Vector( buf, 16, 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -*/ -declare var ctor: Complex128Vector; - - -// EXPORTS // - -export = ctor; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 8400946..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 r}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-vector-ctor@v0.1.1-esm/index.mjs";var t=r("complex128");export{t as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index fc76095..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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Complex128Vector\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 Complex128Vector();\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 Complex128Vector( 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.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( 64 );\n* var arr = new Complex128Vector( buf );\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( 48 );\n* var arr = new Complex128Vector( buf, 16 );\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( 64 );\n* var arr = new Complex128Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Complex128Vector = factory( 'complex128' );\n\n\n// EXPORTS //\n\nexport default Complex128Vector;\n"],"names":["Complex128Vector","factory"],"mappings":";;yGAuGG,IAACA,EAAmBC,EAAS"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index e10f927..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 2a080094de3fa131ac5e7ddfe393dd4180dd565a Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 19 Aug 2026 03:42:38 +0000 Subject: [PATCH 34/37] 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 | 205 - .npmignore | 229 - .npmrc | 44 - CHANGELOG.md | 87 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 87 +- 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 | 49 - 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 | 71 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 1024 ---- 45 files changed, 4889 insertions(+), 5410 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 9fbaee1..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2026-08-19T03:18:31.011Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 53d0027..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/complex128) 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 eb573d9..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/complex128) 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 f060126..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: '43 19 * * 2' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 83d50c4..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,821 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send notification to Zulip if job fails: - - name: 'Send notification to Zulip in case of failure' - # Pin action to full length commit SHA - uses: zulip/github-actions-zulip/send-message@e4c8f27c732ba9bd98ac6be0583096dea82feea5 # v1.0.2 - if: failure() - with: - api-key: ${{ secrets.ZULIP_API_KEY }} - email: 'github-actions-bot@stdlib.zulipchat.com' - organization-url: 'https://stdlib.zulipchat.com' - to: 'workflows-standalone' - type: 'stream' - topic: ${{ github.event.repository.name }} - content: | - :cross_mark: **${{ github.workflow }}** workflow failed - - **Repository:** [${{ github.repository }}](${{ github.server_url }}/${{ github.repository }}) - **Run:** [View workflow run](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}) - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -250,7 +241,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]. @@ -313,37 +304,37 @@ Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-vector-complex128/main/LICENSE -[@stdlib/array/buffer]: https://github.com/stdlib-js/array-buffer +[@stdlib/array/buffer]: https://github.com/stdlib-js/array-buffer/tree/esm -[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor +[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor/tree/esm -[@stdlib/ndarray/matrix/complex128]: https://github.com/stdlib-js/ndarray-matrix-complex128 +[@stdlib/ndarray/matrix/complex128]: https://github.com/stdlib-js/ndarray-matrix-complex128/tree/esm -[@stdlib/ndarray/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/float32]: https://github.com/stdlib-js/ndarray-vector-float32 +[@stdlib/ndarray/vector/float32]: https://github.com/stdlib-js/ndarray-vector-float32/tree/esm -[@stdlib/ndarray/vector/int16]: https://github.com/stdlib-js/ndarray-vector-int16 +[@stdlib/ndarray/vector/int16]: https://github.com/stdlib-js/ndarray-vector-int16/tree/esm -[@stdlib/ndarray/vector/int32]: https://github.com/stdlib-js/ndarray-vector-int32 +[@stdlib/ndarray/vector/int32]: https://github.com/stdlib-js/ndarray-vector-int32/tree/esm -[@stdlib/ndarray/vector/int8]: https://github.com/stdlib-js/ndarray-vector-int8 +[@stdlib/ndarray/vector/int8]: https://github.com/stdlib-js/ndarray-vector-int8/tree/esm -[@stdlib/ndarray/vector/uint16]: https://github.com/stdlib-js/ndarray-vector-uint16 +[@stdlib/ndarray/vector/uint16]: https://github.com/stdlib-js/ndarray-vector-uint16/tree/esm -[@stdlib/ndarray/vector/uint32]: https://github.com/stdlib-js/ndarray-vector-uint32 +[@stdlib/ndarray/vector/uint32]: https://github.com/stdlib-js/ndarray-vector-uint32/tree/esm -[@stdlib/ndarray/vector/uint8]: https://github.com/stdlib-js/ndarray-vector-uint8 +[@stdlib/ndarray/vector/uint8]: https://github.com/stdlib-js/ndarray-vector-uint8/tree/esm -[@stdlib/ndarray/vector/uint8c]: https://github.com/stdlib-js/ndarray-vector-uint8c +[@stdlib/ndarray/vector/uint8c]: https://github.com/stdlib-js/ndarray-vector-uint8c/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/bool]: https://github.com/stdlib-js/ndarray-vector-bool +[@stdlib/ndarray/vector/bool]: https://github.com/stdlib-js/ndarray-vector-bool/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 be3b5e9..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 Complex128Vector = require( './../lib' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var arr; - var i; - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr = new Complex128Vector( 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 6331119..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 Complex128Vector = 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 Complex128Vector( 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 ec929f5..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/complex128" -%% click B href "https://github.com/stdlib-js/ndarray-vector-complex128/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-vector-complex128/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-vector-complex128/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-vector-complex128/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-vector-complex128/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/vector/complex128 -[production-url]: https://github.com/stdlib-js/ndarray-vector-complex128/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-vector-complex128/tree/deno -[deno-readme]: https://github.com/stdlib-js/ndarray-vector-complex128/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/ndarray-vector-complex128/tree/umd -[umd-readme]: https://github.com/stdlib-js/ndarray-vector-complex128/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/ndarray-vector-complex128/tree/esm -[esm-readme]: https://github.com/stdlib-js/ndarray-vector-complex128/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 19ed956..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var c=function(o,r){return function(){try{return r||o((r={exports:{}}).exports,r),r.exports}catch(a){throw (r=0, a)}};};var t=c(function(x,e){ -var s=require('@stdlib/ndarray-vector-ctor/dist').factory,i=s("complex128");e.exports=i -});var p=t();module.exports=p; -/** @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 7fc3136..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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Complex128Vector\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 Complex128Vector();\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 Complex128Vector( 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.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( 64 );\n* var arr = new Complex128Vector( buf );\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( 48 );\n* var arr = new Complex128Vector( buf, 16 );\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( 64 );\n* var arr = new Complex128Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Complex128Vector = factory( 'complex128' );\n\n\n// EXPORTS //\n\nmodule.exports = Complex128Vector;\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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @module @stdlib/ndarray-vector-complex128\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var v = new Complex128Vector();\n* // returns \n*\n* var len = numel( v );\n* // returns 0\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var v = new Complex128Vector( 2 );\n* // returns \n*\n* var len = numel( v );\n* // returns 2\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var v = new Complex128Vector( [ 1.0, 2.0, 3.0, 4.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 Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var buf = new ArrayBuffer( 64 );\n* var v = new Complex128Vector( buf );\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 Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var buf = new ArrayBuffer( 48 );\n* var v = new Complex128Vector( buf, 16 );\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 Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var buf = new ArrayBuffer( 64 );\n* var v = new Complex128Vector( 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": "iIAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,QAAS,6BAA8B,EAAE,QAiFnDC,EAAmBD,EAAS,YAAa,EAK7CD,EAAO,QAAUE,ICdjB,IAAIC,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "factory", "Complex128Vector", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 718f62a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,175 +0,0 @@ - -{{alias}}( [options] ) - Returns a one-dimensional double-precision complex 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 double-precision complex 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 double-precision complex 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, 4.0, 5.0, 6.0 ]; - > var arr = {{alias}}( v ) - - > var len = {{alias:@stdlib/ndarray/numel}}( arr ) - 3 - - -{{alias}}( buffer[, byteOffset[, length]][, options] ) - Returns a one-dimensional double-precision complex 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}}( 64 ); - > var arr = {{alias}}( buf, 0, 2 ) - - > var len = {{alias:@stdlib/ndarray/numel}}( arr ) - 2 - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 79a3121..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 Complex128Vector = require( './index' ); - - -// TESTS // - -// The function returns an ndarray... -{ - new Complex128Vector(); // $ExpectType complex128ndarray - new Complex128Vector( {} ); // $ExpectType complex128ndarray - - new Complex128Vector( 10 ); // $ExpectType complex128ndarray - new Complex128Vector( 10, {} ); // $ExpectType complex128ndarray - - new Complex128Vector( [ 1, 2, 3, 4 ] ); // $ExpectType complex128ndarray - new Complex128Vector( [ 1, 2, 3, 4 ], {} ); // $ExpectType complex128ndarray - - new Complex128Vector( new ArrayBuffer( 10 ) ); // $ExpectType complex128ndarray - new Complex128Vector( new ArrayBuffer( 10 ), {} ); // $ExpectType complex128ndarray - - new Complex128Vector( new ArrayBuffer( 10 ), 8 ); // $ExpectType complex128ndarray - new Complex128Vector( new ArrayBuffer( 10 ), 8, {} ); // $ExpectType complex128ndarray - - new Complex128Vector( new ArrayBuffer( 10 ), 8, 0 ); // $ExpectType complex128ndarray - new Complex128Vector( new ArrayBuffer( 10 ), 8, 0, {} ); // $ExpectType complex128ndarray - - const vector = Complex128Vector; - vector(); // $ExpectType complex128ndarray - vector( {} ); // $ExpectType complex128ndarray - - vector( 10 ); // $ExpectType complex128ndarray - vector( 10, {} ); // $ExpectType complex128ndarray - - vector( [ 1, 2, 3, 4 ] ); // $ExpectType complex128ndarray - vector( [ 1, 2, 3, 4 ], {} ); // $ExpectType complex128ndarray - - vector( new ArrayBuffer( 10 ) ); // $ExpectType complex128ndarray - vector( new ArrayBuffer( 10 ), {} ); // $ExpectType complex128ndarray - - vector( new ArrayBuffer( 10 ), 8 ); // $ExpectType complex128ndarray - vector( new ArrayBuffer( 10 ), 8, {} ); // $ExpectType complex128ndarray - - vector( new ArrayBuffer( 10 ), 8, 0 ); // $ExpectType complex128ndarray - vector( new ArrayBuffer( 10 ), 8, 0, {} ); // $ExpectType complex128ndarray -} - -// 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 Complex128Vector( true ); // $ExpectError - new Complex128Vector( false ); // $ExpectError - new Complex128Vector( null ); // $ExpectError - new Complex128Vector( ( x: number ): number => x ); // $ExpectError - - const vector = Complex128Vector; - 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 Complex128Vector( buf, 8, 2, {}, {} ); // $ExpectError - - const vector = Complex128Vector; - vector( buf, 8, 2, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 0cc3779..0000000 --- a/examples/index.js +++ /dev/null @@ -1,49 +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 real = require( '@stdlib/complex-float64-real' ); -var imag = require( '@stdlib/complex-float64-imag' ); -var Complex128 = require( '@stdlib/complex-float64-ctor' ); -var Complex128Vector = require( './../lib' ); - -// Create a vector containing random values: -var x = new Complex128Vector( discreteUniform( 20, 0, 100 ) ); - -// Compute the sum: -var v = sum( x ); -console.log( v.get() ); - -// Define a function which applies a threshold to real and imaginary components: -function threshold( v ) { - if ( real( v ) > 10 && imag( v ) > 10 ) { - return v; - } - return new Complex128( 0.0, 0.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 deda8c2..5a1608e 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -20,7 +20,7 @@ /* eslint-disable @typescript-eslint/unified-signatures */ -/// +/// import { Order, Mode, complex128ndarray } 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..8400946 --- /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 r}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-vector-ctor@v0.1.1-esm/index.mjs";var t=r("complex128");export{t as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..fc76095 --- /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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Complex128Vector\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 Complex128Vector();\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 Complex128Vector( 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.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( 64 );\n* var arr = new Complex128Vector( buf );\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( 48 );\n* var arr = new Complex128Vector( buf, 16 );\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( 64 );\n* var arr = new Complex128Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Complex128Vector = factory( 'complex128' );\n\n\n// EXPORTS //\n\nexport default Complex128Vector;\n"],"names":["Complex128Vector","factory"],"mappings":";;yGAuGG,IAACA,EAAmBC,EAAS"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 872d251..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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray). -* -* @module @stdlib/ndarray-vector-complex128 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var v = new Complex128Vector(); -* // returns -* -* var len = numel( v ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var v = new Complex128Vector( 2 ); -* // returns -* -* var len = numel( v ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var v = new Complex128Vector( [ 1.0, 2.0, 3.0, 4.0 ] ); -* // returns -* -* var len = numel( v ); -* // returns 2 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var buf = new ArrayBuffer( 64 ); -* var v = new Complex128Vector( buf ); -* // returns -* -* var len = numel( v ); -* // returns 4 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var buf = new ArrayBuffer( 48 ); -* var v = new Complex128Vector( buf, 16 ); -* // returns -* -* var len = numel( v ); -* // returns 2 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var buf = new ArrayBuffer( 64 ); -* var v = new Complex128Vector( 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 e9fb219..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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray). -* -* @name Complex128Vector -* @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 Complex128Vector(); -* // returns -* -* var len = numel( arr ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Complex128Vector( 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Complex128Vector( [ 1.0, 2.0, 3.0, 4.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( 64 ); -* var arr = new Complex128Vector( buf ); -* // returns -* -* var len = numel( arr ); -* // returns 4 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 48 ); -* var arr = new Complex128Vector( buf, 16 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 64 ); -* var arr = new Complex128Vector( buf, 16, 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -*/ -var Complex128Vector = factory( 'complex128' ); - - -// EXPORTS // - -module.exports = Complex128Vector; diff --git a/package.json b/package.json index 39c7799..ebe5dcf 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.1", "description": "Create a double-precision complex 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,50 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/ndarray-vector-ctor": "^0.1.1", - "@stdlib/types": "^0.5.1" - }, - "devDependencies": { - "@stdlib/array-buffer": "^0.2.3", - "@stdlib/array-complex128": "^0.3.2", - "@stdlib/array-float32": "^0.2.3", - "@stdlib/assert-is-ndarray-like": "^0.2.3", - "@stdlib/assert-is-ndarray-like-with-data-type": "^0.1.1", - "@stdlib/assert-is-same-complex128array": "^0.2.3", - "@stdlib/blas-ext-sum": "^0.1.1", - "@stdlib/buffer-from-array": "^0.2.3", - "@stdlib/complex-float64-ctor": "^0.1.2", - "@stdlib/complex-float64-imag": "^0.1.2", - "@stdlib/complex-float64-real": "^0.1.2", - "@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..e10f927 --- /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 be638c1..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 isSameComplex128Array = require( '@stdlib/assert-is-same-complex128array' ); -var isReadOnly = require( '@stdlib/ndarray-base-assert-is-read-only' ); -var ArrayBuffer = require( '@stdlib/array-buffer' ); -var Float32Array = require( '@stdlib/array-float32' ); -var Complex128Array = require( '@stdlib/array-complex128' ); -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 Complex128Vector = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof Complex128Vector, '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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( [], 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector({ - '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 Complex128Vector({ - '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 Complex128Vector({ - 'readonly': value - }); - }; - } -}); - -tape( 'the function returns a one-dimensional ndarray', function test( t ) { - var arr; - - arr = new Complex128Vector(); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 0, 'returns expected value' ); - - arr = new Complex128Vector( {} ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( 10 ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 10, 'returns expected value' ); - - arr = new Complex128Vector( 10, {} ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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, 5.0, 6.0, 7.0, 8.0 ]; - - out = new Complex128Vector( arr ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( arr ) ), true, 'returns expected value' ); - - out = new Complex128Vector( arr, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( 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 Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - - out = new Complex128Vector( arr ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( arr ) ), true, 'returns expected value' ); - - out = new Complex128Vector( arr, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( 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, 5, 6, 7, 8 ]; - buf = array2buffer( arr ); - - out = new Complex128Vector( buf ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( arr ) ), true, 'returns expected value' ); - - out = new Complex128Vector( buf, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( 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( 32 ); - - out = new Complex128Vector( buf ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 2, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( buf ) ), true, 'returns expected value' ); - - out = new Complex128Vector( buf, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 2, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( 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( 64 ); - - out = new Complex128Vector( buf, 16 ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 3, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( buf, 16 ) ), true, 'returns expected value' ); - - out = new Complex128Vector( buf, 16, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 3, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( buf, 16 ) ), 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( 64 ); - - out = new Complex128Vector( buf, 16, 2 ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 2, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( buf, 16, 2 ) ), true, 'returns expected value' ); - - out = new Complex128Vector( buf, 16, 2, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 2, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( buf, 16, 2 ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout', function test( t ) { - var arr; - - arr = new Complex128Vector({ - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 0, 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Complex128Vector({ - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( 10, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 10, 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Complex128Vector( 10, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ], { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 4, 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Complex128Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ], { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( new ArrayBuffer( 64 ), { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 4, 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Complex128Vector( new ArrayBuffer( 64 ), { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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, byteoffset)', function test( t ) { - var arr; - - arr = new Complex128Vector( new ArrayBuffer( 64 ), 16, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 3, 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Complex128Vector( new ArrayBuffer( 64 ), 16, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 3, '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 Complex128Vector( new ArrayBuffer( 64 ), 16, 2, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 2, 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Complex128Vector( new ArrayBuffer( 64 ), 16, 2, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector({ - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( 10, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ], { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( new ArrayBuffer( 64 ), { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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, byteoffset)', function test( t ) { - var arr; - - arr = new Complex128Vector( new ArrayBuffer( 64 ), 16, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 3, '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 Complex128Vector( new ArrayBuffer( 64 ), 16, 2, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector({ - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( 10, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ], { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( new ArrayBuffer( 64 ), { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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, byteoffset)', function test( t ) { - var arr; - - arr = new Complex128Vector( new ArrayBuffer( 64 ), 16, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 3, '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 Complex128Vector( new ArrayBuffer( 64 ), 16, 2, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 2, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -}); From 4ea723bc20ecd25244a7f7c7bdfde1902ec1ef32 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 4 Oct 2026 03:24:07 +0000 Subject: [PATCH 35/37] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 00b116b..39c7799 100644 --- a/package.json +++ b/package.json @@ -59,7 +59,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 cd8bf8e3aadad495a0fe6a845b9de4d91112d0e0 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 4 Oct 2026 03:38:24 +0000 Subject: [PATCH 36/37] 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 5a1608e..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, complex128ndarray } 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 Complex128Vector { - /** - * Creates a double-precision complex 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 Complex128Vector(); - * // returns - * - * var len = numel( arr ); - * // returns 0 - */ - new ( options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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 Complex128Vector( 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( length: number, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.0 ] ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( obj: Collection | AccessorArrayLike | Iterable, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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 Complex128Vector( buf ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( buffer: ArrayBuffer, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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( 64 ); - * var arr = new Complex128Vector( buf, 16 ); - * // returns - * - * var len = numel( arr ); - * // returns 3 - */ - new ( buffer: ArrayBuffer, byteOffset: number, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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( 64 ); - * var arr = new Complex128Vector( buf, 16, 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - new ( buffer: ArrayBuffer, byteOffset: number, length: number, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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 Complex128Vector(); - * // returns - * - * var len = numel( arr ); - * // returns 0 - */ - ( options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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 Complex128Vector( 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( length: number, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.0 ] ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( obj: Collection | AccessorArrayLike | Iterable, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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( 64 ); - * var arr = new Complex128Vector( buf ); - * // returns - * - * var len = numel( arr ); - * // returns 4 - */ - ( buffer: ArrayBuffer, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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( 64 ); - * var arr = new Complex128Vector( buf, 16 ); - * // returns - * - * var len = numel( arr ); - * // returns 3 - */ - ( buffer: ArrayBuffer, byteOffset: number, options?: Options ): complex128ndarray; - - /** - * Creates a double-precision complex 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( 64 ); - * var arr = new Complex128Vector( buf, 16, 2 ); - * // returns - * - * var len = numel( arr ); - * // returns 2 - */ - ( buffer: ArrayBuffer, byteOffset: number, length: number, options?: Options ): complex128ndarray; -} - -/** -* Creates a double-precision complex 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 Complex128Vector(); -* // returns -* -* var len = numel( arr ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Complex128Vector( 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Complex128Vector( [ 1.0, 2.0, 3.0, 4.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( 64 ); -* var arr = new Complex128Vector( buf, 16, 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -*/ -declare var ctor: Complex128Vector; - - -// EXPORTS // - -export = ctor; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 8400946..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 r}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-vector-ctor@v0.1.1-esm/index.mjs";var t=r("complex128");export{t as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index fc76095..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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Complex128Vector\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 Complex128Vector();\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 Complex128Vector( 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.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( 64 );\n* var arr = new Complex128Vector( buf );\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( 48 );\n* var arr = new Complex128Vector( buf, 16 );\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( 64 );\n* var arr = new Complex128Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Complex128Vector = factory( 'complex128' );\n\n\n// EXPORTS //\n\nexport default Complex128Vector;\n"],"names":["Complex128Vector","factory"],"mappings":";;yGAuGG,IAACA,EAAmBC,EAAS"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index e10f927..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From dedaa0354609a0ef2e77aae966638c0570b4d531 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 4 Oct 2026 03:38:51 +0000 Subject: [PATCH 37/37] 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 | 205 - .npmignore | 229 - .npmrc | 44 - CHANGELOG.md | 87 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 87 +- 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 | 49 - 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 | 71 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 1024 ---- 45 files changed, 4889 insertions(+), 5410 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 8ebd1ee..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2026-10-04T03:17:42.601Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 53d0027..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/complex128) 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 eb573d9..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/complex128) 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 f060126..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: '43 19 * * 2' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 83d50c4..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,821 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send notification to Zulip if job fails: - - name: 'Send notification to Zulip in case of failure' - # Pin action to full length commit SHA - uses: zulip/github-actions-zulip/send-message@e4c8f27c732ba9bd98ac6be0583096dea82feea5 # v1.0.2 - if: failure() - with: - api-key: ${{ secrets.ZULIP_API_KEY }} - email: 'github-actions-bot@stdlib.zulipchat.com' - organization-url: 'https://stdlib.zulipchat.com' - to: 'workflows-standalone' - type: 'stream' - topic: ${{ github.event.repository.name }} - content: | - :cross_mark: **${{ github.workflow }}** workflow failed - - **Repository:** [${{ github.repository }}](${{ github.server_url }}/${{ github.repository }}) - **Run:** [View workflow run](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}) - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -250,7 +241,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]. @@ -313,37 +304,37 @@ Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-vector-complex128/main/LICENSE -[@stdlib/array/buffer]: https://github.com/stdlib-js/array-buffer +[@stdlib/array/buffer]: https://github.com/stdlib-js/array-buffer/tree/esm -[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor +[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor/tree/esm -[@stdlib/ndarray/matrix/complex128]: https://github.com/stdlib-js/ndarray-matrix-complex128 +[@stdlib/ndarray/matrix/complex128]: https://github.com/stdlib-js/ndarray-matrix-complex128/tree/esm -[@stdlib/ndarray/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/float32]: https://github.com/stdlib-js/ndarray-vector-float32 +[@stdlib/ndarray/vector/float32]: https://github.com/stdlib-js/ndarray-vector-float32/tree/esm -[@stdlib/ndarray/vector/int16]: https://github.com/stdlib-js/ndarray-vector-int16 +[@stdlib/ndarray/vector/int16]: https://github.com/stdlib-js/ndarray-vector-int16/tree/esm -[@stdlib/ndarray/vector/int32]: https://github.com/stdlib-js/ndarray-vector-int32 +[@stdlib/ndarray/vector/int32]: https://github.com/stdlib-js/ndarray-vector-int32/tree/esm -[@stdlib/ndarray/vector/int8]: https://github.com/stdlib-js/ndarray-vector-int8 +[@stdlib/ndarray/vector/int8]: https://github.com/stdlib-js/ndarray-vector-int8/tree/esm -[@stdlib/ndarray/vector/uint16]: https://github.com/stdlib-js/ndarray-vector-uint16 +[@stdlib/ndarray/vector/uint16]: https://github.com/stdlib-js/ndarray-vector-uint16/tree/esm -[@stdlib/ndarray/vector/uint32]: https://github.com/stdlib-js/ndarray-vector-uint32 +[@stdlib/ndarray/vector/uint32]: https://github.com/stdlib-js/ndarray-vector-uint32/tree/esm -[@stdlib/ndarray/vector/uint8]: https://github.com/stdlib-js/ndarray-vector-uint8 +[@stdlib/ndarray/vector/uint8]: https://github.com/stdlib-js/ndarray-vector-uint8/tree/esm -[@stdlib/ndarray/vector/uint8c]: https://github.com/stdlib-js/ndarray-vector-uint8c +[@stdlib/ndarray/vector/uint8c]: https://github.com/stdlib-js/ndarray-vector-uint8c/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/bool]: https://github.com/stdlib-js/ndarray-vector-bool +[@stdlib/ndarray/vector/bool]: https://github.com/stdlib-js/ndarray-vector-bool/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 be3b5e9..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 Complex128Vector = require( './../lib' ); - - -// MAIN // - -bench( pkg, function benchmark( b ) { - var arr; - var i; - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - arr = new Complex128Vector( 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 6331119..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 Complex128Vector = 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 Complex128Vector( 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 ec929f5..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/complex128" -%% click B href "https://github.com/stdlib-js/ndarray-vector-complex128/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-vector-complex128/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-vector-complex128/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-vector-complex128/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-vector-complex128/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/vector/complex128 -[production-url]: https://github.com/stdlib-js/ndarray-vector-complex128/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-vector-complex128/tree/deno -[deno-readme]: https://github.com/stdlib-js/ndarray-vector-complex128/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/ndarray-vector-complex128/tree/umd -[umd-readme]: https://github.com/stdlib-js/ndarray-vector-complex128/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/ndarray-vector-complex128/tree/esm -[esm-readme]: https://github.com/stdlib-js/ndarray-vector-complex128/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 19ed956..0000000 --- a/dist/index.js +++ /dev/null @@ -1,5 +0,0 @@ -"use strict";var c=function(o,r){return function(){try{return r||o((r={exports:{}}).exports,r),r.exports}catch(a){throw (r=0, a)}};};var t=c(function(x,e){ -var s=require('@stdlib/ndarray-vector-ctor/dist').factory,i=s("complex128");e.exports=i -});var p=t();module.exports=p; -/** @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 7fc3136..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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Complex128Vector\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 Complex128Vector();\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 Complex128Vector( 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.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( 64 );\n* var arr = new Complex128Vector( buf );\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( 48 );\n* var arr = new Complex128Vector( buf, 16 );\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( 64 );\n* var arr = new Complex128Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Complex128Vector = factory( 'complex128' );\n\n\n// EXPORTS //\n\nmodule.exports = Complex128Vector;\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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @module @stdlib/ndarray-vector-complex128\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var v = new Complex128Vector();\n* // returns \n*\n* var len = numel( v );\n* // returns 0\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var v = new Complex128Vector( 2 );\n* // returns \n*\n* var len = numel( v );\n* // returns 2\n*\n* @example\n* var numel = require( '@stdlib/ndarray-numel' );\n* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var v = new Complex128Vector( [ 1.0, 2.0, 3.0, 4.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 Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var buf = new ArrayBuffer( 64 );\n* var v = new Complex128Vector( buf );\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 Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var buf = new ArrayBuffer( 48 );\n* var v = new Complex128Vector( buf, 16 );\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 Complex128Vector = require( '@stdlib/ndarray-vector-complex128' );\n*\n* var buf = new ArrayBuffer( 64 );\n* var v = new Complex128Vector( 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": "iIAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,QAAS,6BAA8B,EAAE,QAiFnDC,EAAmBD,EAAS,YAAa,EAK7CD,EAAO,QAAUE,ICdjB,IAAIC,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_main", "__commonJSMin", "exports", "module", "factory", "Complex128Vector", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 718f62a..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,175 +0,0 @@ - -{{alias}}( [options] ) - Returns a one-dimensional double-precision complex 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 double-precision complex 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 double-precision complex 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, 4.0, 5.0, 6.0 ]; - > var arr = {{alias}}( v ) - - > var len = {{alias:@stdlib/ndarray/numel}}( arr ) - 3 - - -{{alias}}( buffer[, byteOffset[, length]][, options] ) - Returns a one-dimensional double-precision complex 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}}( 64 ); - > var arr = {{alias}}( buf, 0, 2 ) - - > var len = {{alias:@stdlib/ndarray/numel}}( arr ) - 2 - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 79a3121..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 Complex128Vector = require( './index' ); - - -// TESTS // - -// The function returns an ndarray... -{ - new Complex128Vector(); // $ExpectType complex128ndarray - new Complex128Vector( {} ); // $ExpectType complex128ndarray - - new Complex128Vector( 10 ); // $ExpectType complex128ndarray - new Complex128Vector( 10, {} ); // $ExpectType complex128ndarray - - new Complex128Vector( [ 1, 2, 3, 4 ] ); // $ExpectType complex128ndarray - new Complex128Vector( [ 1, 2, 3, 4 ], {} ); // $ExpectType complex128ndarray - - new Complex128Vector( new ArrayBuffer( 10 ) ); // $ExpectType complex128ndarray - new Complex128Vector( new ArrayBuffer( 10 ), {} ); // $ExpectType complex128ndarray - - new Complex128Vector( new ArrayBuffer( 10 ), 8 ); // $ExpectType complex128ndarray - new Complex128Vector( new ArrayBuffer( 10 ), 8, {} ); // $ExpectType complex128ndarray - - new Complex128Vector( new ArrayBuffer( 10 ), 8, 0 ); // $ExpectType complex128ndarray - new Complex128Vector( new ArrayBuffer( 10 ), 8, 0, {} ); // $ExpectType complex128ndarray - - const vector = Complex128Vector; - vector(); // $ExpectType complex128ndarray - vector( {} ); // $ExpectType complex128ndarray - - vector( 10 ); // $ExpectType complex128ndarray - vector( 10, {} ); // $ExpectType complex128ndarray - - vector( [ 1, 2, 3, 4 ] ); // $ExpectType complex128ndarray - vector( [ 1, 2, 3, 4 ], {} ); // $ExpectType complex128ndarray - - vector( new ArrayBuffer( 10 ) ); // $ExpectType complex128ndarray - vector( new ArrayBuffer( 10 ), {} ); // $ExpectType complex128ndarray - - vector( new ArrayBuffer( 10 ), 8 ); // $ExpectType complex128ndarray - vector( new ArrayBuffer( 10 ), 8, {} ); // $ExpectType complex128ndarray - - vector( new ArrayBuffer( 10 ), 8, 0 ); // $ExpectType complex128ndarray - vector( new ArrayBuffer( 10 ), 8, 0, {} ); // $ExpectType complex128ndarray -} - -// 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 Complex128Vector( true ); // $ExpectError - new Complex128Vector( false ); // $ExpectError - new Complex128Vector( null ); // $ExpectError - new Complex128Vector( ( x: number ): number => x ); // $ExpectError - - const vector = Complex128Vector; - 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 Complex128Vector( buf, 8, 2, {}, {} ); // $ExpectError - - const vector = Complex128Vector; - vector( buf, 8, 2, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 0cc3779..0000000 --- a/examples/index.js +++ /dev/null @@ -1,49 +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 real = require( '@stdlib/complex-float64-real' ); -var imag = require( '@stdlib/complex-float64-imag' ); -var Complex128 = require( '@stdlib/complex-float64-ctor' ); -var Complex128Vector = require( './../lib' ); - -// Create a vector containing random values: -var x = new Complex128Vector( discreteUniform( 20, 0, 100 ) ); - -// Compute the sum: -var v = sum( x ); -console.log( v.get() ); - -// Define a function which applies a threshold to real and imaginary components: -function threshold( v ) { - if ( real( v ) > 10 && imag( v ) > 10 ) { - return v; - } - return new Complex128( 0.0, 0.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 deda8c2..5a1608e 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -20,7 +20,7 @@ /* eslint-disable @typescript-eslint/unified-signatures */ -/// +/// import { Order, Mode, complex128ndarray } 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..8400946 --- /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 r}from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-vector-ctor@v0.1.1-esm/index.mjs";var t=r("complex128");export{t as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..fc76095 --- /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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray).\n*\n* @name Complex128Vector\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 Complex128Vector();\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 Complex128Vector( 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.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( 64 );\n* var arr = new Complex128Vector( buf );\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( 48 );\n* var arr = new Complex128Vector( buf, 16 );\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( 64 );\n* var arr = new Complex128Vector( buf, 16, 2 );\n* // returns \n*\n* var len = numel( arr );\n* // returns 2\n*/\nvar Complex128Vector = factory( 'complex128' );\n\n\n// EXPORTS //\n\nexport default Complex128Vector;\n"],"names":["Complex128Vector","factory"],"mappings":";;yGAuGG,IAACA,EAAmBC,EAAS"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 872d251..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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray). -* -* @module @stdlib/ndarray-vector-complex128 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var v = new Complex128Vector(); -* // returns -* -* var len = numel( v ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var v = new Complex128Vector( 2 ); -* // returns -* -* var len = numel( v ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var v = new Complex128Vector( [ 1.0, 2.0, 3.0, 4.0 ] ); -* // returns -* -* var len = numel( v ); -* // returns 2 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var buf = new ArrayBuffer( 64 ); -* var v = new Complex128Vector( buf ); -* // returns -* -* var len = numel( v ); -* // returns 4 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var buf = new ArrayBuffer( 48 ); -* var v = new Complex128Vector( buf, 16 ); -* // returns -* -* var len = numel( v ); -* // returns 2 -* -* @example -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* var numel = require( '@stdlib/ndarray-numel' ); -* var Complex128Vector = require( '@stdlib/ndarray-vector-complex128' ); -* -* var buf = new ArrayBuffer( 64 ); -* var v = new Complex128Vector( 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 e9fb219..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 double-precision complex floating-point vector (i.e., a one-dimensional ndarray). -* -* @name Complex128Vector -* @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 Complex128Vector(); -* // returns -* -* var len = numel( arr ); -* // returns 0 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Complex128Vector( 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* -* var arr = new Complex128Vector( [ 1.0, 2.0, 3.0, 4.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( 64 ); -* var arr = new Complex128Vector( buf ); -* // returns -* -* var len = numel( arr ); -* // returns 4 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 48 ); -* var arr = new Complex128Vector( buf, 16 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -* -* @example -* var numel = require( '@stdlib/ndarray-numel' ); -* var ArrayBuffer = require( '@stdlib/array-buffer' ); -* -* var buf = new ArrayBuffer( 64 ); -* var arr = new Complex128Vector( buf, 16, 2 ); -* // returns -* -* var len = numel( arr ); -* // returns 2 -*/ -var Complex128Vector = factory( 'complex128' ); - - -// EXPORTS // - -module.exports = Complex128Vector; diff --git a/package.json b/package.json index 39c7799..ebe5dcf 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.1", "description": "Create a double-precision complex 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,50 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/ndarray-vector-ctor": "^0.1.1", - "@stdlib/types": "^0.5.1" - }, - "devDependencies": { - "@stdlib/array-buffer": "^0.2.3", - "@stdlib/array-complex128": "^0.3.2", - "@stdlib/array-float32": "^0.2.3", - "@stdlib/assert-is-ndarray-like": "^0.2.3", - "@stdlib/assert-is-ndarray-like-with-data-type": "^0.1.1", - "@stdlib/assert-is-same-complex128array": "^0.2.3", - "@stdlib/blas-ext-sum": "^0.1.1", - "@stdlib/buffer-from-array": "^0.2.3", - "@stdlib/complex-float64-ctor": "^0.1.2", - "@stdlib/complex-float64-imag": "^0.1.2", - "@stdlib/complex-float64-real": "^0.1.2", - "@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..e10f927 --- /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 be638c1..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 isSameComplex128Array = require( '@stdlib/assert-is-same-complex128array' ); -var isReadOnly = require( '@stdlib/ndarray-base-assert-is-read-only' ); -var ArrayBuffer = require( '@stdlib/array-buffer' ); -var Float32Array = require( '@stdlib/array-float32' ); -var Complex128Array = require( '@stdlib/array-complex128' ); -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 Complex128Vector = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof Complex128Vector, '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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( [], 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector( 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 Complex128Vector({ - '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 Complex128Vector({ - '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 Complex128Vector({ - 'readonly': value - }); - }; - } -}); - -tape( 'the function returns a one-dimensional ndarray', function test( t ) { - var arr; - - arr = new Complex128Vector(); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 0, 'returns expected value' ); - - arr = new Complex128Vector( {} ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( 10 ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 10, 'returns expected value' ); - - arr = new Complex128Vector( 10, {} ); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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, 5.0, 6.0, 7.0, 8.0 ]; - - out = new Complex128Vector( arr ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( arr ) ), true, 'returns expected value' ); - - out = new Complex128Vector( arr, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( 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 Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] ); - - out = new Complex128Vector( arr ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( arr ) ), true, 'returns expected value' ); - - out = new Complex128Vector( arr, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( 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, 5, 6, 7, 8 ]; - buf = array2buffer( arr ); - - out = new Complex128Vector( buf ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( arr ) ), true, 'returns expected value' ); - - out = new Complex128Vector( buf, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 4, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( 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( 32 ); - - out = new Complex128Vector( buf ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 2, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( buf ) ), true, 'returns expected value' ); - - out = new Complex128Vector( buf, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 2, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( 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( 64 ); - - out = new Complex128Vector( buf, 16 ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 3, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( buf, 16 ) ), true, 'returns expected value' ); - - out = new Complex128Vector( buf, 16, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 3, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( buf, 16 ) ), 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( 64 ); - - out = new Complex128Vector( buf, 16, 2 ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 2, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( buf, 16, 2 ) ), true, 'returns expected value' ); - - out = new Complex128Vector( buf, 16, 2, {} ); - t.strictEqual( isndarrayLikeWithDataType( out, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( out ), 2, 'returns expected value' ); - t.strictEqual( isSameComplex128Array( getData( out ), new Complex128Array( buf, 16, 2 ) ), true, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the memory layout', function test( t ) { - var arr; - - arr = new Complex128Vector({ - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 0, 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Complex128Vector({ - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( 10, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 10, 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Complex128Vector( 10, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ], { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 4, 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Complex128Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ], { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( new ArrayBuffer( 64 ), { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 4, 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Complex128Vector( new ArrayBuffer( 64 ), { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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, byteoffset)', function test( t ) { - var arr; - - arr = new Complex128Vector( new ArrayBuffer( 64 ), 16, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 3, 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Complex128Vector( new ArrayBuffer( 64 ), 16, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 3, '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 Complex128Vector( new ArrayBuffer( 64 ), 16, 2, { - 'order': 'row-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 2, 'returns expected value' ); - t.strictEqual( getOrder( arr ), 'row-major', 'returns expected value' ); - - arr = new Complex128Vector( new ArrayBuffer( 64 ), 16, 2, { - 'order': 'column-major' - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector({ - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( 10, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ], { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( new ArrayBuffer( 64 ), { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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, byteoffset)', function test( t ) { - var arr; - - arr = new Complex128Vector( new ArrayBuffer( 64 ), 16, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 3, '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 Complex128Vector( new ArrayBuffer( 64 ), 16, 2, { - 'readonly': true - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector({ - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( 10, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ], { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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 Complex128Vector( new ArrayBuffer( 64 ), { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), 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, byteoffset)', function test( t ) { - var arr; - - arr = new Complex128Vector( new ArrayBuffer( 64 ), 16, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 3, '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 Complex128Vector( new ArrayBuffer( 64 ), 16, 2, { - 'readonly': false - }); - t.strictEqual( isndarrayLikeWithDataType( arr, 'complex128' ), true, 'returns expected value' ); - t.strictEqual( numel( arr ), 2, 'returns expected value' ); - t.strictEqual( isReadOnly( arr ), false, 'returns expected value' ); - - t.end(); -});