From 7c3dcb81a111a6a423e79722cb29cc5108d20a98 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 12 May 2025 09:54:40 +0000 Subject: [PATCH 1/5] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 5fc97bc..1a8a147 100644 --- a/package.json +++ b/package.json @@ -41,7 +41,8 @@ "@stdlib/array-base-take-indexed": "^0.2.2", "@stdlib/array-base-zero-to": "^0.2.1", "@stdlib/ndarray-base-strides2order": "^0.2.2", - "@stdlib/types": "^0.4.3" + "@stdlib/types": "^0.4.3", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2" }, "devDependencies": { "@stdlib/assert-is-array": "^0.2.2", @@ -95,4 +96,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From aa602a8e8d14335ea0fe96266d2f91e824e88f32 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 12 May 2025 09:55:25 +0000 Subject: [PATCH 2/5] Auto-generated commit --- .editorconfig | 180 - .eslintrc.js | 1 - .gitattributes | 66 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 794 --- .github/workflows/publish.yml | 252 - .github/workflows/test.yml | 99 - .github/workflows/test_bundles.yml | 186 - .github/workflows/test_coverage.yml | 133 - .github/workflows/test_install.yml | 85 - .github/workflows/test_published_package.yml | 105 - .gitignore | 194 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 48 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 43 +- SECURITY.md | 5 - benchmark/benchmark.js | 87 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 44 - docs/types/test.ts | 92 - examples/index.js | 35 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 58 - lib/main.js | 144 - lib/sort2ins.js | 98 - package.json | 64 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 208 - 44 files changed, 4868 insertions(+), 4296 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 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 (97%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/sort2ins.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 9a4638d..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/base/loop-interchange-order) 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 78e87a6..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/base/loop-interchange-order) 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 4bf6cb5..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: '42 18 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index f4575e9..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,794 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA - uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 - with: - status: ${{ job.status }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -185,7 +176,7 @@ console.log( o ); ## 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]. @@ -252,7 +243,7 @@ Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors]. [loop-nest-optimization]: https://en.wikipedia.org/wiki/Loop_nest_optimization -[@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 d6744f1..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,87 +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 isArrayArray = require( '@stdlib/assert-is-array-array' ); -var pkg = require( './../package.json' ).name; -var loopOrder = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::row-major', function benchmark( b ) { - var strides; - var shape; - var out; - var st; - var i; - - shape = [ 10, 10, 10 ]; - strides = [ - [ 100, 10, 1 ], - [ 200, 20, 2 ] - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - st = strides[ i%strides.length ]; - out = loopOrder( shape, [ st, st, st ] ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isArrayArray( out ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::column-major', function benchmark( b ) { - var strides; - var shape; - var out; - var st; - var i; - - shape = [ 10, 10, 10 ]; - strides = [ - [ 1, 10, 100 ], - [ 2, 20, 200 ] - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - st = strides[ i%strides.length ]; - out = loopOrder( shape, [ st, st, st ] ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isArrayArray( out ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 95534c3..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/base/loop-interchange-order" -%% click B href "https://github.com/stdlib-js/ndarray-base-loop-interchange-order/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-base-loop-interchange-order/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-base-loop-interchange-order/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-base-loop-interchange-order/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-base-loop-interchange-order/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/loop-interchange-order -[production-url]: https://github.com/stdlib-js/ndarray-base-loop-interchange-order/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-base-loop-interchange-order/tree/deno -[deno-readme]: https://github.com/stdlib-js/ndarray-base-loop-interchange-order/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/ndarray-base-loop-interchange-order/tree/umd -[umd-readme]: https://github.com/stdlib-js/ndarray-base-loop-interchange-order/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/ndarray-base-loop-interchange-order/tree/esm -[esm-readme]: https://github.com/stdlib-js/ndarray-base-loop-interchange-order/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 b82998c..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import loopOrder from '../docs/types/index'; -export = loopOrder; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 6858078..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var h=function(i,e){return function(){return e||i((e={exports:{}}).exports,e),e.exports}};var g=h(function(N,p){ -function j(i,e){var f,a,t,n,o,u,v,s,r,l;for(t=1,n=1,l=1;l=0&&(r=i[o],a=r<0?-r:r,!(a<=f));)i[o+1]=r,e[u+1]=e[u],o-=1,u-=1;i[o+1]=v,e[u+1]=s,t+=1,n+=1}}p.exports=j -});var q=h(function(O,c){ -var k=require('@stdlib/array-base-zero-to/dist'),m=require('@stdlib/array-base-copy-indexed/dist'),x=require('@stdlib/array-base-take-indexed/dist'),b=require('@stdlib/ndarray-base-strides2order/dist'),w=g();function y(i,e){var f,a,t,n,o,u,v,s,r,l;for(v=e.length,a=[],r=0;r<4;r++)a.push([]);for(s=a.length,r=0;r=t&&(t=n,l=r);u=a[l][0]}for(f=k(i.length),w(m(u),f),o=[x(i,f)],r=0;r [ 1, -2, 3, -4 ]\n*\n* console.log( y );\n* // => [ 3, 1, 2, 0 ]\n*/\nfunction sort2ins( x, y ) {\n\tvar avx;\n\tvar aux;\n\tvar ix;\n\tvar iy;\n\tvar jx;\n\tvar jy;\n\tvar vx;\n\tvar vy;\n\tvar ux;\n\tvar i;\n\n\tix = 1;\n\tiy = 1;\n\n\t// Sort in increasing order...\n\tfor ( i = 1; i < x.length; i++ ) {\n\t\tvx = x[ ix ];\n\t\tavx = ( vx < 0 ) ? -vx : vx;\n\n\t\tvy = y[ iy ];\n\n\t\tjx = ix - 1;\n\t\tjy = iy - 1;\n\n\t\t// Shift all larger values to the left of the current element to the right...\n\t\twhile ( jx >= 0 ) {\n\t\t\tux = x[ jx ];\n\t\t\taux = ( ux < 0 ) ? -ux : ux;\n\t\t\tif ( aux <= avx ) {\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tx[ jx+1 ] = ux;\n\t\t\ty[ jy+1 ] = y[ jy ];\n\t\t\tjx -= 1;\n\t\t\tjy -= 1;\n\t\t}\n\t\tx[ jx+1 ] = vx;\n\t\ty[ jy+1 ] = vy;\n\t\tix += 1;\n\t\tiy += 1;\n\t}\n}\n\n\n// EXPORTS //\n\nmodule.exports = sort2ins;\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// MODULES //\n\nvar zeroTo = require( '@stdlib/array-base-zero-to' );\nvar copy = require( '@stdlib/array-base-copy-indexed' );\nvar take = require( '@stdlib/array-base-take-indexed' );\nvar strides2order = require( '@stdlib/ndarray-base-strides2order' );\nvar sort2ins = require( './sort2ins.js' );\n\n\n// MAIN //\n\n/**\n* Reorders ndarray dimensions and associated strides for loop interchange.\n*\n* ## Notes\n*\n* - The returned array has the following elements:\n*\n* ```text\n* [ , ... ]\n* ```\n*\n* where\n*\n* - **shape**: dimensions sorted in loop order.\n* - **...strides**: strides for each respective ndarray sorted in loop order.\n*\n* @param {NonNegativeIntegerArray} shape - array dimensions\n* @param {ArrayLikeObject>} strides - list of stride arrays containing the stride lengths for each input and output ndarray\n* @returns {Array} loop interchange data\n*\n* @example\n* var sh = [ 2, 3, 4 ];\n*\n* var sx = [ 12, 4, 1 ]; // row-major\n* var sy = [ 24, 8, 1 ]; // row-major\n* var sz = [ 1, -2, 6 ]; // column-major\n*\n* var o = loopOrder( sh, [ sx, sy, sz ] );\n* // returns [...]\n*\n* var ssh = o[ 0 ];\n* // returns [ 4, 3, 2 ]\n*\n* var ssx = o[ 1 ];\n* // returns [ 1, 4, 12 ]\n*\n* var ssy = o[ 2 ];\n* // returns [ 1, 8, 24 ]\n*\n* var ssz = o[ 3 ];\n* // returns [ 6, -2, 1 ]\n*/\nfunction loopOrder( shape, strides ) {\n\tvar idx;\n\tvar tmp;\n\tvar max;\n\tvar len;\n\tvar out;\n\tvar st;\n\tvar N;\n\tvar M;\n\tvar i;\n\tvar j;\n\n\tN = strides.length;\n\n\t// Initialize an array for grouping stride arrays according to memory layout:\n\ttmp = [];\n\tfor ( i = 0; i < 4; i++ ) { // note: `4` corresponds to the number of possible return values from `strides2order`\n\t\ttmp.push( [] );\n\t}\n\tM = tmp.length;\n\n\t// Group stride arrays according to memory layout:\n\tfor ( i = 0; i < N; i++ ) {\n\t\ttmp[ strides2order( strides[ i ] ) ].push( strides[ i ] );\n\t}\n\t// Determine which array should be used to generate the loop order:\n\tmax = tmp[ 0 ].length;\n\tif ( max === N ) {\n\t\t// If all arrays are \"disorganized\", then just use the first array, as, generally, each array is likely to be as un-ideal as every other:\n\t\tst = strides[ 0 ];\n\t} else if ( max === N-1 ) {\n\t\t// If all but one array is \"disorganized\", find the \"organized\" array...\n\t\tfor ( i = 1; i < M; i++ ) {\n\t\t\tif ( tmp[ i ].length ) {\n\t\t\t\tst = tmp[ i ][ 0 ];\n\t\t\t\tbreak;\n\t\t\t}\n\t\t}\n\t} else {\n\t\t// Find the layout which is most common...\n\t\tj = 0;\n\t\tfor ( i = 1; i < M; i++ ) {\n\t\t\tlen = tmp[ i ].length;\n\t\t\tif ( len >= max ) {\n\t\t\t\tmax = len;\n\t\t\t\tj = i;\n\t\t\t}\n\t\t}\n\t\t// Use the strides of the first array having the most common layout:\n\t\tst = tmp[ j ][ 0 ];\n\t}\n\t// Initialize a loop interchange index array for generating a loop order permutation:\n\tidx = zeroTo( shape.length );\n\n\t// Sort strides in increasing order of magnitude:\n\tsort2ins( copy( st ), idx );\n\n\t// Permute the shape based on the sorted strides:\n\tout = [ take( shape, idx ) ];\n\n\t// Permute each stride array based on the sorted strides:\n\tfor ( i = 0; i < N; i++ ) {\n\t\tout.push( take( strides[ i ], idx ) );\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = loopOrder;\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* Reorder ndarray dimensions and associated strides for loop interchange.\n*\n* @module @stdlib/ndarray-base-loop-interchange-order\n*\n* @example\n* var loopOrder = require( '@stdlib/ndarray-base-loop-interchange-order' );\n*\n* var sh = [ 2, 3, 4 ];\n*\n* var sx = [ 12, 4, 1 ]; // row-major\n* var sy = [ 24, 8, 1 ]; // row-major\n* var sz = [ 1, -2, 6 ]; // column-major\n*\n* var o = loopOrder( sh, [ sx, sy, sz ] );\n* // returns [...]\n*\n* var ssh = o[ 0 ];\n* // returns [ 4, 3, 2 ]\n*\n* var ssx = o[ 1 ];\n* // returns [ 1, 4, 12 ]\n*\n* var ssy = o[ 2 ];\n* // returns [ 1, 8, 24 ]\n*\n* var ssz = o[ 3 ];\n* // returns [ 6, -2, 1 ]\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,cAkDA,SAASC,EAAUC,EAAGC,EAAI,CACzB,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAP,EAAK,EACLC,EAAK,EAGCM,EAAI,EAAGA,EAAIX,EAAE,OAAQW,IAAM,CAUhC,IATAH,EAAKR,EAAGI,CAAG,EACXF,EAAQM,EAAK,EAAM,CAACA,EAAKA,EAEzBC,EAAKR,EAAGI,CAAG,EAEXC,EAAKF,EAAK,EACVG,EAAKF,EAAK,EAGFC,GAAM,IACbI,EAAKV,EAAGM,CAAG,EACXH,EAAQO,EAAK,EAAM,CAACA,EAAKA,EACpB,EAAAP,GAAOD,KAGZF,EAAGM,EAAG,CAAE,EAAII,EACZT,EAAGM,EAAG,CAAE,EAAIN,EAAGM,CAAG,EAClBD,GAAM,EACNC,GAAM,EAEPP,EAAGM,EAAG,CAAE,EAAIE,EACZP,EAAGM,EAAG,CAAE,EAAIE,EACZL,GAAM,EACNC,GAAM,CACP,CACD,CAKAP,EAAO,QAAUC,ICjGjB,IAAAa,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAS,QAAS,4BAA6B,EAC/CC,EAAO,QAAS,iCAAkC,EAClDC,EAAO,QAAS,iCAAkC,EAClDC,EAAgB,QAAS,oCAAqC,EAC9DC,EAAW,IA+Cf,SAASC,EAAWC,EAAOC,EAAU,CACpC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAH,EAAIP,EAAQ,OAGZE,EAAM,CAAC,EACDO,EAAI,EAAGA,EAAI,EAAGA,IACnBP,EAAI,KAAM,CAAC,CAAE,EAKd,IAHAM,EAAIN,EAAI,OAGFO,EAAI,EAAGA,EAAIF,EAAGE,IACnBP,EAAKN,EAAeI,EAASS,CAAE,CAAE,CAAE,EAAE,KAAMT,EAASS,CAAE,CAAE,EAIzD,GADAN,EAAMD,EAAK,CAAE,EAAE,OACVC,IAAQI,EAEZD,EAAKN,EAAS,CAAE,UACLG,IAAQI,EAAE,GAErB,IAAME,EAAI,EAAGA,EAAID,EAAGC,IACnB,GAAKP,EAAKO,CAAE,EAAE,OAAS,CACtBH,EAAKJ,EAAKO,CAAE,EAAG,CAAE,EACjB,KACD,MAEK,CAGN,IADAC,EAAI,EACED,EAAI,EAAGA,EAAID,EAAGC,IACnBL,EAAMF,EAAKO,CAAE,EAAE,OACVL,GAAOD,IACXA,EAAMC,EACNM,EAAID,GAINH,EAAKJ,EAAKQ,CAAE,EAAG,CAAE,CAClB,CAWA,IATAT,EAAMR,EAAQM,EAAM,MAAO,EAG3BF,EAAUH,EAAMY,CAAG,EAAGL,CAAI,EAG1BI,EAAM,CAAEV,EAAMI,EAAOE,CAAI,CAAE,EAGrBQ,EAAI,EAAGA,EAAIF,EAAGE,IACnBJ,EAAI,KAAMV,EAAMK,EAASS,CAAE,EAAGR,CAAI,CAAE,EAErC,OAAOI,CACR,CAKAb,EAAO,QAAUM,IC3FjB,IAAIa,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_sort2ins", "__commonJSMin", "exports", "module", "sort2ins", "x", "y", "avx", "aux", "ix", "iy", "jx", "jy", "vx", "vy", "ux", "i", "require_main", "__commonJSMin", "exports", "module", "zeroTo", "copy", "take", "strides2order", "sort2ins", "loopOrder", "shape", "strides", "idx", "tmp", "max", "len", "out", "st", "N", "M", "i", "j", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index df2a6d8..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,44 +0,0 @@ - -{{alias}}( shape, strides ) - Reorders ndarray dimensions and associated strides for loop interchange. - - The function returns an array having the following elements: - - [ , ... ] - - where - - - shape: dimensions sorted in loop order. - - strides: strides for each respective ndarray sorted in loop order. - - For all returned arrays, the first element corresponds to the innermost - loop, and the last element corresponds to the outermost loop. - - The function assumes that the input and output ndarrays have the same shape. - Hence, loop interchange order should only be determined after broadcasting. - - Parameters - ---------- - shape: Array - Array dimensions. - - strides: Array> - List of stride arrays containing the stride lengths for each input and - output ndarray. - - Returns - ------- - out: Array - Loop interchange data. - - Examples - -------- - > var x = {{alias:@stdlib/ndarray/array}}( [ [ 1, 2 ], [ 3, 4 ] ] ); - > var y = {{alias:@stdlib/ndarray/array}}( [ [ 5, 6 ], [ 7, 8 ] ] ); - > var z = {{alias:@stdlib/ndarray/array}}( [ [ 0, 0 ], [ 0, 0 ] ] ); - > var o = {{alias}}( x.shape, [ x.strides, y.strides, z.strides ] ) - [...] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index ff519ca..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,92 +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 loopOrder = require( './index' ); - - -// TESTS // - -// The function returns an array of arrays... -{ - const sh = [ 2, 2 ]; - const sx = [ 2, 1 ]; - const sy = [ 2, 1 ]; - const sz = [ 4, 2 ]; - loopOrder( sh, [ sx, sy, sz ] ); // $ExpectType number[][] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object of numbers... -{ - const sx = [ 2, 1 ]; - const sy = [ 2, 1 ]; - const sz = [ 4, 2 ]; - - loopOrder( true, [ sx, sy, sz ] ); // $ExpectError - loopOrder( false, [ sx, sy, sz ] ); // $ExpectError - loopOrder( '5', [ sx, sy, sz ] ); // $ExpectError - loopOrder( 123, [ sx, sy, sz ] ); // $ExpectError - loopOrder( {}, [ sx, sy, sz ] ); // $ExpectError - loopOrder( ( x: number ): number => x, [ sx, sy, sz ] ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing arrays of numbers... -{ - const sh = [ 2, 2 ]; - const sx = [ 2, 1 ]; - const sy = [ 2, 1 ]; - const sz = [ 4, 2 ]; - - loopOrder( sh, true ); // $ExpectError - loopOrder( sh, false ); // $ExpectError - loopOrder( sh, '5' ); // $ExpectError - loopOrder( sh, 123 ); // $ExpectError - loopOrder( sh, {} ); // $ExpectError - loopOrder( sh, ( x: number ): number => x ); // $ExpectError - - loopOrder( sh, [ true, sy, sz ] ); // $ExpectError - loopOrder( sh, [ false, sy, sz ] ); // $ExpectError - loopOrder( sh, [ '5', sy, sz ] ); // $ExpectError - loopOrder( sh, [ 123, sy, sz ] ); // $ExpectError - loopOrder( sh, [ {}, sy, sz ] ); // $ExpectError - loopOrder( sh, [ ( x: number ): number => x, sy, sz ] ); // $ExpectError - - loopOrder( sh, [ sx, true, sz ] ); // $ExpectError - loopOrder( sh, [ sx, false, sz ] ); // $ExpectError - loopOrder( sh, [ sx, '5', sz ] ); // $ExpectError - loopOrder( sh, [ sx, 123, sz ] ); // $ExpectError - loopOrder( sh, [ sx, {}, sz ] ); // $ExpectError - - loopOrder( sh, [ sx, sy, true ] ); // $ExpectError - loopOrder( sh, [ sx, sy, false ] ); // $ExpectError - loopOrder( sh, [ sx, sy, '5' ] ); // $ExpectError - loopOrder( sh, [ sx, sy, 123 ] ); // $ExpectError - loopOrder( sh, [ sx, sy, {} ] ); // $ExpectError - loopOrder( sh, [ sx, sy, ( x: number ): number => x ] ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const sh = [ 2, 2 ]; - const sx = [ 2, 1 ]; - const sy = [ 2, 1 ]; - const sz = [ 4, 2 ]; - - loopOrder(); // $ExpectError - loopOrder( sh ); // $ExpectError - loopOrder( sh, [ sx, sy, sz ], [] ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index f6f1973..0000000 --- a/examples/index.js +++ /dev/null @@ -1,35 +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 array = require( '@stdlib/ndarray-array' ); -var getShape = require( '@stdlib/ndarray-shape' ); -var getStrides = require( '@stdlib/ndarray-strides' ); -var loopOrder = require( './../lib' ); - -// Create ndarrays: -var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -var y = array( [ [ 5, 6 ], [ 7, 8 ] ] ); -var z = array( [ [ 0, 0 ], [ 0, 0 ] ] ); - -// Resolve loop interchange data: -var o = loopOrder( getShape( x ), [ getStrides( x ), getStrides( y ), getStrides( z ) ] ); // eslint-disable-line max-len -// returns [...] - -console.log( o ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 97% rename from docs/types/index.d.ts rename to index.d.ts index a65ff56..17840d9 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { ArrayLike } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..79980b3 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2025 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-zero-to@v0.2.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-copy-indexed@v0.2.2-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take-indexed@v0.2.2-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-strides2order@v0.2.2-esm/index.mjs";function n(n,d){var i,o,a,h,l,f,m,p,j,g;for(m=d.length,o=[],j=0;j<4;j++)o.push([]);for(p=o.length,j=0;j=a&&(a=h,g=j);f=o[g][0]}for(i=e(n.length),function(e,r){var s,t,n,d,i,o,a,h,l;for(t=1,n=1,l=1;l=0&&!(((h=e[d])<0?-h:h)<=s);)e[d+1]=h,r[i+1]=r[i],d-=1,i-=1;e[d+1]=o,r[i+1]=a,t+=1,n+=1}}(r(f),i),l=[s(n,i)],j=0;j, ... ]\n* ```\n*\n* where\n*\n* - **shape**: dimensions sorted in loop order.\n* - **...strides**: strides for each respective ndarray sorted in loop order.\n*\n* @param {NonNegativeIntegerArray} shape - array dimensions\n* @param {ArrayLikeObject>} strides - list of stride arrays containing the stride lengths for each input and output ndarray\n* @returns {Array} loop interchange data\n*\n* @example\n* var sh = [ 2, 3, 4 ];\n*\n* var sx = [ 12, 4, 1 ]; // row-major\n* var sy = [ 24, 8, 1 ]; // row-major\n* var sz = [ 1, -2, 6 ]; // column-major\n*\n* var o = loopOrder( sh, [ sx, sy, sz ] );\n* // returns [...]\n*\n* var ssh = o[ 0 ];\n* // returns [ 4, 3, 2 ]\n*\n* var ssx = o[ 1 ];\n* // returns [ 1, 4, 12 ]\n*\n* var ssy = o[ 2 ];\n* // returns [ 1, 8, 24 ]\n*\n* var ssz = o[ 3 ];\n* // returns [ 6, -2, 1 ]\n*/\nfunction loopOrder( shape, strides ) {\n\tvar idx;\n\tvar tmp;\n\tvar max;\n\tvar len;\n\tvar out;\n\tvar st;\n\tvar N;\n\tvar M;\n\tvar i;\n\tvar j;\n\n\tN = strides.length;\n\n\t// Initialize an array for grouping stride arrays according to memory layout:\n\ttmp = [];\n\tfor ( i = 0; i < 4; i++ ) { // note: `4` corresponds to the number of possible return values from `strides2order`\n\t\ttmp.push( [] );\n\t}\n\tM = tmp.length;\n\n\t// Group stride arrays according to memory layout:\n\tfor ( i = 0; i < N; i++ ) {\n\t\ttmp[ strides2order( strides[ i ] ) ].push( strides[ i ] );\n\t}\n\t// Determine which array should be used to generate the loop order:\n\tmax = tmp[ 0 ].length;\n\tif ( max === N ) {\n\t\t// If all arrays are \"disorganized\", then just use the first array, as, generally, each array is likely to be as un-ideal as every other:\n\t\tst = strides[ 0 ];\n\t} else if ( max === N-1 ) {\n\t\t// If all but one array is \"disorganized\", find the \"organized\" array...\n\t\tfor ( i = 1; i < M; i++ ) {\n\t\t\tif ( tmp[ i ].length ) {\n\t\t\t\tst = tmp[ i ][ 0 ];\n\t\t\t\tbreak;\n\t\t\t}\n\t\t}\n\t} else {\n\t\t// Find the layout which is most common...\n\t\tj = 0;\n\t\tfor ( i = 1; i < M; i++ ) {\n\t\t\tlen = tmp[ i ].length;\n\t\t\tif ( len >= max ) {\n\t\t\t\tmax = len;\n\t\t\t\tj = i;\n\t\t\t}\n\t\t}\n\t\t// Use the strides of the first array having the most common layout:\n\t\tst = tmp[ j ][ 0 ];\n\t}\n\t// Initialize a loop interchange index array for generating a loop order permutation:\n\tidx = zeroTo( shape.length );\n\n\t// Sort strides in increasing order of magnitude:\n\tsort2ins( copy( st ), idx );\n\n\t// Permute the shape based on the sorted strides:\n\tout = [ take( shape, idx ) ];\n\n\t// Permute each stride array based on the sorted strides:\n\tfor ( i = 0; i < N; i++ ) {\n\t\tout.push( take( strides[ i ], idx ) );\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default loopOrder;\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// MAIN //\n\n/**\n* Simultaneously sorts two arrays based on the sort order of the first array using insertion sort.\n*\n* ## Notes\n*\n* - The first array is sorted in increasing order according to absolute value.\n* - The algorithm has space complexity `O(1)` and worst case time complexity `O(N^2)`.\n* - The algorithm is efficient for small arrays (typically `N <= 20`) and is particularly efficient for sorting arrays which are already substantially sorted.\n* - The algorithm is **stable**, meaning that the algorithm does **not** change the order of array elements which are equal or equivalent.\n* - The input arrays are sorted in-place (i.e., the input arrays are mutated).\n*\n* @private\n* @param {Array} x - first array\n* @param {Array} y - second array\n* @returns {void}\n*\n* @example\n* var x = [ -4, -2, 3, 1 ];\n* var y = [ 0, 1, 2, 3 ];\n*\n* sort2ins( x, y );\n*\n* console.log( x );\n* // => [ 1, -2, 3, -4 ]\n*\n* console.log( y );\n* // => [ 3, 1, 2, 0 ]\n*/\nfunction sort2ins( x, y ) {\n\tvar avx;\n\tvar aux;\n\tvar ix;\n\tvar iy;\n\tvar jx;\n\tvar jy;\n\tvar vx;\n\tvar vy;\n\tvar ux;\n\tvar i;\n\n\tix = 1;\n\tiy = 1;\n\n\t// Sort in increasing order...\n\tfor ( i = 1; i < x.length; i++ ) {\n\t\tvx = x[ ix ];\n\t\tavx = ( vx < 0 ) ? -vx : vx;\n\n\t\tvy = y[ iy ];\n\n\t\tjx = ix - 1;\n\t\tjy = iy - 1;\n\n\t\t// Shift all larger values to the left of the current element to the right...\n\t\twhile ( jx >= 0 ) {\n\t\t\tux = x[ jx ];\n\t\t\taux = ( ux < 0 ) ? -ux : ux;\n\t\t\tif ( aux <= avx ) {\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tx[ jx+1 ] = ux;\n\t\t\ty[ jy+1 ] = y[ jy ];\n\t\t\tjx -= 1;\n\t\t\tjy -= 1;\n\t\t}\n\t\tx[ jx+1 ] = vx;\n\t\ty[ jy+1 ] = vy;\n\t\tix += 1;\n\t\tiy += 1;\n\t}\n}\n\n\n// EXPORTS //\n\nexport default sort2ins;\n"],"names":["loopOrder","shape","strides","idx","tmp","max","len","out","st","N","M","i","j","length","push","strides2order","zeroTo","x","y","avx","ix","iy","jx","jy","vx","vy","ux","sort2ins","copy","take"],"mappings":";;sYAyEA,SAASA,EAAWC,EAAOC,GAC1B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAH,EAAIP,EAAQW,OAGZT,EAAM,GACAO,EAAI,EAAGA,EAAI,EAAGA,IACnBP,EAAIU,KAAM,IAKX,IAHAJ,EAAIN,EAAIS,OAGFF,EAAI,EAAGA,EAAIF,EAAGE,IACnBP,EAAKW,EAAeb,EAASS,KAAQG,KAAMZ,EAASS,IAIrD,IADAN,EAAMD,EAAK,GAAIS,UACFJ,EAEZD,EAAKN,EAAS,QACR,GAAKG,IAAQI,EAAE,GAErB,IAAME,EAAI,EAAGA,EAAID,EAAGC,IACnB,GAAKP,EAAKO,GAAIE,OAAS,CACtBL,EAAKJ,EAAKO,GAAK,GACf,KACA,MAEI,CAGN,IADAC,EAAI,EACED,EAAI,EAAGA,EAAID,EAAGC,KACnBL,EAAMF,EAAKO,GAAIE,SACHR,IACXA,EAAMC,EACNM,EAAID,GAINH,EAAKJ,EAAKQ,GAAK,EACf,CAWD,IATAT,EAAMa,EAAQf,EAAMY,QC3ErB,SAAmBI,EAAGC,GACrB,IAAIC,EAEAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAf,EAMJ,IAJAS,EAAK,EACLC,EAAK,EAGCV,EAAI,EAAGA,EAAIM,EAAEJ,OAAQF,IAAM,CAUhC,IARAQ,GADAK,EAAKP,EAAGG,IACK,GAAOI,EAAKA,EAEzBC,EAAKP,EAAGG,GAERC,EAAKF,EAAK,EACVG,EAAKF,EAAK,EAGFC,GAAM,OACbI,EAAKT,EAAGK,IACK,GAAOI,EAAKA,IACbP,IAGZF,EAAGK,EAAG,GAAMI,EACZR,EAAGK,EAAG,GAAML,EAAGK,GACfD,GAAM,EACNC,GAAM,EAEPN,EAAGK,EAAG,GAAME,EACZN,EAAGK,EAAG,GAAME,EACZL,GAAM,EACNC,GAAM,CACN,CACF,CDoCCM,CAAUC,EAAMpB,GAAML,GAGtBI,EAAM,CAAEsB,EAAM5B,EAAOE,IAGfQ,EAAI,EAAGA,EAAIF,EAAGE,IACnBJ,EAAIO,KAAMe,EAAM3B,EAASS,GAAKR,IAE/B,OAAOI,CACR"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 4213c09..0000000 --- a/lib/index.js +++ /dev/null @@ -1,58 +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'; - -/** -* Reorder ndarray dimensions and associated strides for loop interchange. -* -* @module @stdlib/ndarray-base-loop-interchange-order -* -* @example -* var loopOrder = require( '@stdlib/ndarray-base-loop-interchange-order' ); -* -* var sh = [ 2, 3, 4 ]; -* -* var sx = [ 12, 4, 1 ]; // row-major -* var sy = [ 24, 8, 1 ]; // row-major -* var sz = [ 1, -2, 6 ]; // column-major -* -* var o = loopOrder( sh, [ sx, sy, sz ] ); -* // returns [...] -* -* var ssh = o[ 0 ]; -* // returns [ 4, 3, 2 ] -* -* var ssx = o[ 1 ]; -* // returns [ 1, 4, 12 ] -* -* var ssy = o[ 2 ]; -* // returns [ 1, 8, 24 ] -* -* var ssz = o[ 3 ]; -* // returns [ 6, -2, 1 ] -*/ - -// MODULES // - -var main = require( './main.js' ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index e38c3cd..0000000 --- a/lib/main.js +++ /dev/null @@ -1,144 +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 zeroTo = require( '@stdlib/array-base-zero-to' ); -var copy = require( '@stdlib/array-base-copy-indexed' ); -var take = require( '@stdlib/array-base-take-indexed' ); -var strides2order = require( '@stdlib/ndarray-base-strides2order' ); -var sort2ins = require( './sort2ins.js' ); - - -// MAIN // - -/** -* Reorders ndarray dimensions and associated strides for loop interchange. -* -* ## Notes -* -* - The returned array has the following elements: -* -* ```text -* [ , ... ] -* ``` -* -* where -* -* - **shape**: dimensions sorted in loop order. -* - **...strides**: strides for each respective ndarray sorted in loop order. -* -* @param {NonNegativeIntegerArray} shape - array dimensions -* @param {ArrayLikeObject>} strides - list of stride arrays containing the stride lengths for each input and output ndarray -* @returns {Array} loop interchange data -* -* @example -* var sh = [ 2, 3, 4 ]; -* -* var sx = [ 12, 4, 1 ]; // row-major -* var sy = [ 24, 8, 1 ]; // row-major -* var sz = [ 1, -2, 6 ]; // column-major -* -* var o = loopOrder( sh, [ sx, sy, sz ] ); -* // returns [...] -* -* var ssh = o[ 0 ]; -* // returns [ 4, 3, 2 ] -* -* var ssx = o[ 1 ]; -* // returns [ 1, 4, 12 ] -* -* var ssy = o[ 2 ]; -* // returns [ 1, 8, 24 ] -* -* var ssz = o[ 3 ]; -* // returns [ 6, -2, 1 ] -*/ -function loopOrder( shape, strides ) { - var idx; - var tmp; - var max; - var len; - var out; - var st; - var N; - var M; - var i; - var j; - - N = strides.length; - - // Initialize an array for grouping stride arrays according to memory layout: - tmp = []; - for ( i = 0; i < 4; i++ ) { // note: `4` corresponds to the number of possible return values from `strides2order` - tmp.push( [] ); - } - M = tmp.length; - - // Group stride arrays according to memory layout: - for ( i = 0; i < N; i++ ) { - tmp[ strides2order( strides[ i ] ) ].push( strides[ i ] ); - } - // Determine which array should be used to generate the loop order: - max = tmp[ 0 ].length; - if ( max === N ) { - // If all arrays are "disorganized", then just use the first array, as, generally, each array is likely to be as un-ideal as every other: - st = strides[ 0 ]; - } else if ( max === N-1 ) { - // If all but one array is "disorganized", find the "organized" array... - for ( i = 1; i < M; i++ ) { - if ( tmp[ i ].length ) { - st = tmp[ i ][ 0 ]; - break; - } - } - } else { - // Find the layout which is most common... - j = 0; - for ( i = 1; i < M; i++ ) { - len = tmp[ i ].length; - if ( len >= max ) { - max = len; - j = i; - } - } - // Use the strides of the first array having the most common layout: - st = tmp[ j ][ 0 ]; - } - // Initialize a loop interchange index array for generating a loop order permutation: - idx = zeroTo( shape.length ); - - // Sort strides in increasing order of magnitude: - sort2ins( copy( st ), idx ); - - // Permute the shape based on the sorted strides: - out = [ take( shape, idx ) ]; - - // Permute each stride array based on the sorted strides: - for ( i = 0; i < N; i++ ) { - out.push( take( strides[ i ], idx ) ); - } - return out; -} - - -// EXPORTS // - -module.exports = loopOrder; diff --git a/lib/sort2ins.js b/lib/sort2ins.js deleted file mode 100644 index e1022d4..0000000 --- a/lib/sort2ins.js +++ /dev/null @@ -1,98 +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'; - -// MAIN // - -/** -* Simultaneously sorts two arrays based on the sort order of the first array using insertion sort. -* -* ## Notes -* -* - The first array is sorted in increasing order according to absolute value. -* - The algorithm has space complexity `O(1)` and worst case time complexity `O(N^2)`. -* - The algorithm is efficient for small arrays (typically `N <= 20`) and is particularly efficient for sorting arrays which are already substantially sorted. -* - The algorithm is **stable**, meaning that the algorithm does **not** change the order of array elements which are equal or equivalent. -* - The input arrays are sorted in-place (i.e., the input arrays are mutated). -* -* @private -* @param {Array} x - first array -* @param {Array} y - second array -* @returns {void} -* -* @example -* var x = [ -4, -2, 3, 1 ]; -* var y = [ 0, 1, 2, 3 ]; -* -* sort2ins( x, y ); -* -* console.log( x ); -* // => [ 1, -2, 3, -4 ] -* -* console.log( y ); -* // => [ 3, 1, 2, 0 ] -*/ -function sort2ins( x, y ) { - var avx; - var aux; - var ix; - var iy; - var jx; - var jy; - var vx; - var vy; - var ux; - var i; - - ix = 1; - iy = 1; - - // Sort in increasing order... - for ( i = 1; i < x.length; i++ ) { - vx = x[ ix ]; - avx = ( vx < 0 ) ? -vx : vx; - - vy = y[ iy ]; - - jx = ix - 1; - jy = iy - 1; - - // Shift all larger values to the left of the current element to the right... - while ( jx >= 0 ) { - ux = x[ jx ]; - aux = ( ux < 0 ) ? -ux : ux; - if ( aux <= avx ) { - break; - } - x[ jx+1 ] = ux; - y[ jy+1 ] = y[ jy ]; - jx -= 1; - jy -= 1; - } - x[ jx+1 ] = vx; - y[ jy+1 ] = vy; - ix += 1; - iy += 1; - } -} - - -// EXPORTS // - -module.exports = sort2ins; diff --git a/package.json b/package.json index 1a8a147..fe35977 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.0.0", "description": "Reorder ndarray dimensions and associated strides for loop interchange.", "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,40 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-copy-indexed": "^0.2.2", - "@stdlib/array-base-take-indexed": "^0.2.2", - "@stdlib/array-base-zero-to": "^0.2.1", - "@stdlib/ndarray-base-strides2order": "^0.2.2", - "@stdlib/types": "^0.4.3", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/assert-is-array": "^0.2.2", - "@stdlib/assert-is-array-array": "^0.2.2", - "@stdlib/ndarray-array": "^0.2.1", - "@stdlib/ndarray-shape": "^0.2.2", - "@stdlib/ndarray-strides": "^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.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", @@ -91,9 +34,8 @@ "utils", "util" ], - "__stdlib__": {}, "funding": { "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..2d2f0e9 --- /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 f58987a..0000000 --- a/test/test.js +++ /dev/null @@ -1,208 +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 tape = require( 'tape' ); -var isArray = require( '@stdlib/assert-is-array' ); -var loopOrder = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof loopOrder, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function returns loop interchange data (row-major)', function test( t ) { - var sh; - var sx; - var sy; - var sz; - var o; - - sh = [ 4, 2, 2 ]; - sx = [ 4, -2, 1 ]; - sy = [ -4, 2, 1 ]; - sz = [ -8, 4, -2 ]; - - o = loopOrder( sh, [ sx, sy, sz ] ); - - t.notEqual( o[ 0 ], sh, 'returns expected value' ); - t.strictEqual( isArray( o[ 0 ] ), true, 'returns expected value' ); - t.deepEqual( o[ 0 ], [ 2, 2, 4 ], 'returns expected value' ); - - t.notEqual( o[ 1 ], sx, 'returns expected value' ); - t.strictEqual( isArray( o[ 1 ] ), true, 'returns expected value' ); - t.deepEqual( o[ 1 ], [ 1, -2, 4 ], 'returns expected value' ); - - t.notEqual( o[ 2 ], sy, 'returns expected value' ); - t.strictEqual( isArray( o[ 2 ] ), true, 'returns expected value' ); - t.deepEqual( o[ 2 ], [ 1, 2, -4 ], 'returns expected value' ); - - t.notEqual( o[ 3 ], sz, 'returns expected value' ); - t.strictEqual( isArray( o[ 3 ] ), true, 'returns expected value' ); - t.deepEqual( o[ 3 ], [ -2, 4, -8 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns loop interchange data (column-major)', function test( t ) { - var sh; - var sx; - var sy; - var sz; - var o; - - sh = [ 4, 2, 2 ]; - sx = [ 1, -4, 8 ]; - sy = [ -1, 4, 8 ]; - sz = [ -2, 4, -8 ]; - - o = loopOrder( sh, [ sx, sy, sz ] ); - - t.notEqual( o[ 0 ], sh, 'returns expected value' ); - t.strictEqual( isArray( o[ 0 ] ), true, 'returns expected value' ); - t.deepEqual( o[ 0 ], [ 4, 2, 2 ], 'returns expected value' ); - - t.notEqual( o[ 1 ], sx, 'returns expected value' ); - t.strictEqual( isArray( o[ 1 ] ), true, 'returns expected value' ); - t.deepEqual( o[ 1 ], [ 1, -4, 8 ], 'returns expected value' ); - - t.notEqual( o[ 2 ], sy, 'returns expected value' ); - t.strictEqual( isArray( o[ 2 ] ), true, 'returns expected value' ); - t.deepEqual( o[ 2 ], [ -1, 4, 8 ], 'returns expected value' ); - - t.notEqual( o[ 3 ], sz, 'returns expected value' ); - t.strictEqual( isArray( o[ 3 ] ), true, 'returns expected value' ); - t.deepEqual( o[ 3 ], [ -2, 4, -8 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns loop interchange data (mixed order)', function test( t ) { - var sh; - var sx; - var sy; - var sz; - var o; - - sh = [ 4, 2, 2 ]; - sx = [ 4, -2, 1 ]; - sy = [ 1, -4, -8 ]; - sz = [ -8, 4, -2 ]; - - o = loopOrder( sh, [ sx, sy, sz ] ); - - t.notEqual( o[ 0 ], sh, 'returns expected value' ); - t.strictEqual( isArray( o[ 0 ] ), true, 'returns expected value' ); - t.deepEqual( o[ 0 ], [ 2, 2, 4 ], 'returns expected value' ); - - t.notEqual( o[ 1 ], sx, 'returns expected value' ); - t.strictEqual( isArray( o[ 1 ] ), true, 'returns expected value' ); - t.deepEqual( o[ 1 ], [ 1, -2, 4 ], 'returns expected value' ); - - t.notEqual( o[ 2 ], sy, 'returns expected value' ); - t.strictEqual( isArray( o[ 2 ] ), true, 'returns expected value' ); - t.deepEqual( o[ 2 ], [ -8, -4, 1 ], 'returns expected value' ); - - t.notEqual( o[ 3 ], sz, 'returns expected value' ); - t.strictEqual( isArray( o[ 3 ] ), true, 'returns expected value' ); - t.deepEqual( o[ 3 ], [ -2, 4, -8 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns loop interchange data (mostly disorganized)', function test( t ) { - var sh; - var sx; - var sy; - var sz; - var o; - - sh = [ 4, 2, 2 ]; - sx = [ -2, 4, 1 ]; // disorganized - sy = [ -4, 2, 1 ]; // row-major - sz = [ -8, -2, 4 ]; // disorganized - - o = loopOrder( sh, [ sx, sy, sz ] ); - - t.notEqual( o[ 0 ], sh, 'returns expected value' ); - t.strictEqual( isArray( o[ 0 ] ), true, 'returns expected value' ); - t.deepEqual( o[ 0 ], [ 2, 2, 4 ], 'returns expected value' ); - - t.notEqual( o[ 1 ], sx, 'returns expected value' ); - t.strictEqual( isArray( o[ 1 ] ), true, 'returns expected value' ); - t.deepEqual( o[ 1 ], [ 1, 4, -2 ], 'returns expected value' ); - - t.notEqual( o[ 2 ], sy, 'returns expected value' ); - t.strictEqual( isArray( o[ 2 ] ), true, 'returns expected value' ); - t.deepEqual( o[ 2 ], [ 1, 2, -4 ], 'returns expected value' ); - - t.notEqual( o[ 3 ], sz, 'returns expected value' ); - t.strictEqual( isArray( o[ 3 ] ), true, 'returns expected value' ); - t.deepEqual( o[ 3 ], [ 4, -2, -8 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns loop interchange data (all disorganized)', function test( t ) { - var sh; - var sx; - var sy; - var sz; - var o; - - sh = [ 4, 2, 2 ]; - sx = [ -2, 4, 1 ]; // disorganized - sy = [ 1, -4, 2 ]; // disorganized - sz = [ -8, -2, 4 ]; // disorganized - - o = loopOrder( sh, [ sx, sy, sz ] ); - - t.notEqual( o[ 0 ], sh, 'returns expected value' ); - t.strictEqual( isArray( o[ 0 ] ), true, 'returns expected value' ); - t.deepEqual( o[ 0 ], [ 2, 4, 2 ], 'returns expected value' ); - - t.notEqual( o[ 1 ], sx, 'returns expected value' ); - t.strictEqual( isArray( o[ 1 ] ), true, 'returns expected value' ); - t.deepEqual( o[ 1 ], [ 1, -2, 4 ], 'returns expected value' ); - - t.notEqual( o[ 2 ], sy, 'returns expected value' ); - t.strictEqual( isArray( o[ 2 ] ), true, 'returns expected value' ); - t.deepEqual( o[ 2 ], [ 2, 1, -4 ], 'returns expected value' ); - - t.notEqual( o[ 3 ], sz, 'returns expected value' ); - t.strictEqual( isArray( o[ 3 ] ), true, 'returns expected value' ); - t.deepEqual( o[ 3 ], [ 4, -8, -2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if provided empty arrays, the function returns empty arrays', function test( t ) { - var o = loopOrder( [], [ [], [], [] ] ); - t.deepEqual( o[ 0 ], [], 'returns expected value' ); - t.deepEqual( o[ 1 ], [], 'returns expected value' ); - t.deepEqual( o[ 2 ], [], 'returns expected value' ); - t.deepEqual( o[ 3 ], [], 'returns expected value' ); - t.end(); -}); From 03537db34eb515a9baa675b35ba5b9d93cfd6235 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 19 May 2025 02:00:15 +0000 Subject: [PATCH 3/5] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 5fc97bc..1a8a147 100644 --- a/package.json +++ b/package.json @@ -41,7 +41,8 @@ "@stdlib/array-base-take-indexed": "^0.2.2", "@stdlib/array-base-zero-to": "^0.2.1", "@stdlib/ndarray-base-strides2order": "^0.2.2", - "@stdlib/types": "^0.4.3" + "@stdlib/types": "^0.4.3", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2" }, "devDependencies": { "@stdlib/assert-is-array": "^0.2.2", @@ -95,4 +96,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 4e8bcf90e1a8789b90423ebb361b2fd97536d549 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 19 May 2025 02:24:36 +0000 Subject: [PATCH 4/5] Remove files --- index.d.ts | 80 - index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 4927 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 17840d9..0000000 --- a/index.d.ts +++ /dev/null @@ -1,80 +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 - -/// - -import { ArrayLike } from '@stdlib/types/array'; - -/** -* Reorders ndarray dimensions and associated strides for loop interchange. -* -* ## Notes -* -* - The returned array has the following elements: -* -* ```text -* [ , ... ] -* ``` -* -* where -* -* - **shape**: dimensions sorted in loop order. -* - **...strides**: strides for each respective ndarray sorted in loop order. -* -* - When iterating over the elements of a multi-dimensional array, accessing elements which are closer in memory can improve performance. To this end, loop interchange is a technique used in loop nest optimization to improve locality of reference and take advantage of CPU cache. -* -* The purpose of this function is to order ndarray dimensions according to the magnitude of array strides. By using the ordered dimensions and associated strides, one can construct nested loops (one for each dimension) such that the innermost loop iterates over the dimension in which array elements are closest in memory and the outermost loop iterates over the dimension in which array elements are farthest apart in memory. As a consequence, element iteration is optimized to minimize cache misses and ensure locality of reference. -* -* - Cache performance may be degraded if the layout order (i.e., row-major or column-major) differs for the input and output ndarrays. This function is intended to optimize cache performance for the most common layout order. Accordingly, if the output ndarray has a different layout order (e.g., if the input ndarrays are row-major and the output ndarray is column-major), cache misses are likely for the output ndarray. In general, to ensure best performance, input and output ndarrays should have the same layout order. -* -* - The function assumes that the input and output ndarrays have the same shape. Hence, loop interchange order should only be determined **after** broadcasting. -* -* @param shape - array dimensions -* @param strides - list of stride arrays containing the stride lengths for each input and output ndarray -* @returns loop interchange data -* -* @example -* var sh = [ 2, 3, 4 ]; -* -* var sx = [ 12, 4, 1 ]; // row-major -* var sy = [ 24, 8, 1 ]; // row-major -* var sz = [ 1, -2, 6 ]; // column-major -* -* var o = loopOrder( shape, [ sx, sy, sz ] ); -* // returns {...} -* -* var ssh = o[ 0 ]; -* // returns [ 4, 3, 2 ] -* -* var ssx = o[ 1 ]; -* // returns [ 1, 4, 12 ] -* -* var ssy = o[ 2 ]; -* // returns [ 1, 8, 24 ] -* -* var ssz = o[ 3 ]; -* // returns [ 6, -2, 1 ] -*/ -declare function loopOrder( shape: ArrayLike, strides: ArrayLike> ): Array>; - - -// EXPORTS // - -export = loopOrder; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 79980b3..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2025 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import e from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-zero-to@v0.2.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-copy-indexed@v0.2.2-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take-indexed@v0.2.2-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-strides2order@v0.2.2-esm/index.mjs";function n(n,d){var i,o,a,h,l,f,m,p,j,g;for(m=d.length,o=[],j=0;j<4;j++)o.push([]);for(p=o.length,j=0;j=a&&(a=h,g=j);f=o[g][0]}for(i=e(n.length),function(e,r){var s,t,n,d,i,o,a,h,l;for(t=1,n=1,l=1;l=0&&!(((h=e[d])<0?-h:h)<=s);)e[d+1]=h,r[i+1]=r[i],d-=1,i-=1;e[d+1]=o,r[i+1]=a,t+=1,n+=1}}(r(f),i),l=[s(n,i)],j=0;j, ... ]\n* ```\n*\n* where\n*\n* - **shape**: dimensions sorted in loop order.\n* - **...strides**: strides for each respective ndarray sorted in loop order.\n*\n* @param {NonNegativeIntegerArray} shape - array dimensions\n* @param {ArrayLikeObject>} strides - list of stride arrays containing the stride lengths for each input and output ndarray\n* @returns {Array} loop interchange data\n*\n* @example\n* var sh = [ 2, 3, 4 ];\n*\n* var sx = [ 12, 4, 1 ]; // row-major\n* var sy = [ 24, 8, 1 ]; // row-major\n* var sz = [ 1, -2, 6 ]; // column-major\n*\n* var o = loopOrder( sh, [ sx, sy, sz ] );\n* // returns [...]\n*\n* var ssh = o[ 0 ];\n* // returns [ 4, 3, 2 ]\n*\n* var ssx = o[ 1 ];\n* // returns [ 1, 4, 12 ]\n*\n* var ssy = o[ 2 ];\n* // returns [ 1, 8, 24 ]\n*\n* var ssz = o[ 3 ];\n* // returns [ 6, -2, 1 ]\n*/\nfunction loopOrder( shape, strides ) {\n\tvar idx;\n\tvar tmp;\n\tvar max;\n\tvar len;\n\tvar out;\n\tvar st;\n\tvar N;\n\tvar M;\n\tvar i;\n\tvar j;\n\n\tN = strides.length;\n\n\t// Initialize an array for grouping stride arrays according to memory layout:\n\ttmp = [];\n\tfor ( i = 0; i < 4; i++ ) { // note: `4` corresponds to the number of possible return values from `strides2order`\n\t\ttmp.push( [] );\n\t}\n\tM = tmp.length;\n\n\t// Group stride arrays according to memory layout:\n\tfor ( i = 0; i < N; i++ ) {\n\t\ttmp[ strides2order( strides[ i ] ) ].push( strides[ i ] );\n\t}\n\t// Determine which array should be used to generate the loop order:\n\tmax = tmp[ 0 ].length;\n\tif ( max === N ) {\n\t\t// If all arrays are \"disorganized\", then just use the first array, as, generally, each array is likely to be as un-ideal as every other:\n\t\tst = strides[ 0 ];\n\t} else if ( max === N-1 ) {\n\t\t// If all but one array is \"disorganized\", find the \"organized\" array...\n\t\tfor ( i = 1; i < M; i++ ) {\n\t\t\tif ( tmp[ i ].length ) {\n\t\t\t\tst = tmp[ i ][ 0 ];\n\t\t\t\tbreak;\n\t\t\t}\n\t\t}\n\t} else {\n\t\t// Find the layout which is most common...\n\t\tj = 0;\n\t\tfor ( i = 1; i < M; i++ ) {\n\t\t\tlen = tmp[ i ].length;\n\t\t\tif ( len >= max ) {\n\t\t\t\tmax = len;\n\t\t\t\tj = i;\n\t\t\t}\n\t\t}\n\t\t// Use the strides of the first array having the most common layout:\n\t\tst = tmp[ j ][ 0 ];\n\t}\n\t// Initialize a loop interchange index array for generating a loop order permutation:\n\tidx = zeroTo( shape.length );\n\n\t// Sort strides in increasing order of magnitude:\n\tsort2ins( copy( st ), idx );\n\n\t// Permute the shape based on the sorted strides:\n\tout = [ take( shape, idx ) ];\n\n\t// Permute each stride array based on the sorted strides:\n\tfor ( i = 0; i < N; i++ ) {\n\t\tout.push( take( strides[ i ], idx ) );\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default loopOrder;\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// MAIN //\n\n/**\n* Simultaneously sorts two arrays based on the sort order of the first array using insertion sort.\n*\n* ## Notes\n*\n* - The first array is sorted in increasing order according to absolute value.\n* - The algorithm has space complexity `O(1)` and worst case time complexity `O(N^2)`.\n* - The algorithm is efficient for small arrays (typically `N <= 20`) and is particularly efficient for sorting arrays which are already substantially sorted.\n* - The algorithm is **stable**, meaning that the algorithm does **not** change the order of array elements which are equal or equivalent.\n* - The input arrays are sorted in-place (i.e., the input arrays are mutated).\n*\n* @private\n* @param {Array} x - first array\n* @param {Array} y - second array\n* @returns {void}\n*\n* @example\n* var x = [ -4, -2, 3, 1 ];\n* var y = [ 0, 1, 2, 3 ];\n*\n* sort2ins( x, y );\n*\n* console.log( x );\n* // => [ 1, -2, 3, -4 ]\n*\n* console.log( y );\n* // => [ 3, 1, 2, 0 ]\n*/\nfunction sort2ins( x, y ) {\n\tvar avx;\n\tvar aux;\n\tvar ix;\n\tvar iy;\n\tvar jx;\n\tvar jy;\n\tvar vx;\n\tvar vy;\n\tvar ux;\n\tvar i;\n\n\tix = 1;\n\tiy = 1;\n\n\t// Sort in increasing order...\n\tfor ( i = 1; i < x.length; i++ ) {\n\t\tvx = x[ ix ];\n\t\tavx = ( vx < 0 ) ? -vx : vx;\n\n\t\tvy = y[ iy ];\n\n\t\tjx = ix - 1;\n\t\tjy = iy - 1;\n\n\t\t// Shift all larger values to the left of the current element to the right...\n\t\twhile ( jx >= 0 ) {\n\t\t\tux = x[ jx ];\n\t\t\taux = ( ux < 0 ) ? -ux : ux;\n\t\t\tif ( aux <= avx ) {\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tx[ jx+1 ] = ux;\n\t\t\ty[ jy+1 ] = y[ jy ];\n\t\t\tjx -= 1;\n\t\t\tjy -= 1;\n\t\t}\n\t\tx[ jx+1 ] = vx;\n\t\ty[ jy+1 ] = vy;\n\t\tix += 1;\n\t\tiy += 1;\n\t}\n}\n\n\n// EXPORTS //\n\nexport default sort2ins;\n"],"names":["loopOrder","shape","strides","idx","tmp","max","len","out","st","N","M","i","j","length","push","strides2order","zeroTo","x","y","avx","ix","iy","jx","jy","vx","vy","ux","sort2ins","copy","take"],"mappings":";;sYAyEA,SAASA,EAAWC,EAAOC,GAC1B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAH,EAAIP,EAAQW,OAGZT,EAAM,GACAO,EAAI,EAAGA,EAAI,EAAGA,IACnBP,EAAIU,KAAM,IAKX,IAHAJ,EAAIN,EAAIS,OAGFF,EAAI,EAAGA,EAAIF,EAAGE,IACnBP,EAAKW,EAAeb,EAASS,KAAQG,KAAMZ,EAASS,IAIrD,IADAN,EAAMD,EAAK,GAAIS,UACFJ,EAEZD,EAAKN,EAAS,QACR,GAAKG,IAAQI,EAAE,GAErB,IAAME,EAAI,EAAGA,EAAID,EAAGC,IACnB,GAAKP,EAAKO,GAAIE,OAAS,CACtBL,EAAKJ,EAAKO,GAAK,GACf,KACA,MAEI,CAGN,IADAC,EAAI,EACED,EAAI,EAAGA,EAAID,EAAGC,KACnBL,EAAMF,EAAKO,GAAIE,SACHR,IACXA,EAAMC,EACNM,EAAID,GAINH,EAAKJ,EAAKQ,GAAK,EACf,CAWD,IATAT,EAAMa,EAAQf,EAAMY,QC3ErB,SAAmBI,EAAGC,GACrB,IAAIC,EAEAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAf,EAMJ,IAJAS,EAAK,EACLC,EAAK,EAGCV,EAAI,EAAGA,EAAIM,EAAEJ,OAAQF,IAAM,CAUhC,IARAQ,GADAK,EAAKP,EAAGG,IACK,GAAOI,EAAKA,EAEzBC,EAAKP,EAAGG,GAERC,EAAKF,EAAK,EACVG,EAAKF,EAAK,EAGFC,GAAM,OACbI,EAAKT,EAAGK,IACK,GAAOI,EAAKA,IACbP,IAGZF,EAAGK,EAAG,GAAMI,EACZR,EAAGK,EAAG,GAAML,EAAGK,GACfD,GAAM,EACNC,GAAM,EAEPN,EAAGK,EAAG,GAAME,EACZN,EAAGK,EAAG,GAAME,EACZL,GAAM,EACNC,GAAM,CACN,CACF,CDoCCM,CAAUC,EAAMpB,GAAML,GAGtBI,EAAM,CAAEsB,EAAM5B,EAAOE,IAGfQ,EAAI,EAAGA,EAAIF,EAAGE,IACnBJ,EAAIO,KAAMe,EAAM3B,EAASS,GAAKR,IAE/B,OAAOI,CACR"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 2d2f0e9..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 24cd5b5c6737e7f7cd7451e07ff35bf2c39ab46b Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 19 May 2025 02:24:58 +0000 Subject: [PATCH 5/5] Auto-generated commit --- .editorconfig | 180 - .eslintrc.js | 1 - .gitattributes | 66 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 794 --- .github/workflows/publish.yml | 252 - .github/workflows/test.yml | 99 - .github/workflows/test_bundles.yml | 186 - .github/workflows/test_coverage.yml | 133 - .github/workflows/test_install.yml | 85 - .github/workflows/test_published_package.yml | 105 - .gitignore | 194 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 48 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 43 +- SECURITY.md | 5 - benchmark/benchmark.js | 87 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 44 - docs/types/test.ts | 92 - examples/index.js | 35 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 58 - lib/main.js | 144 - lib/sort2ins.js | 98 - package.json | 64 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 208 - 45 files changed, 4868 insertions(+), 4297 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 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 (97%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/sort2ins.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 2ea340a..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2025-05-19T01:44:14.363Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 9a4638d..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/base/loop-interchange-order) 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 78e87a6..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/base/loop-interchange-order) 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 4bf6cb5..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: '42 18 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index f4575e9..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,794 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA - uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 - with: - status: ${{ job.status }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -185,7 +176,7 @@ console.log( o ); ## 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]. @@ -252,7 +243,7 @@ Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors]. [loop-nest-optimization]: https://en.wikipedia.org/wiki/Loop_nest_optimization -[@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 d6744f1..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,87 +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 isArrayArray = require( '@stdlib/assert-is-array-array' ); -var pkg = require( './../package.json' ).name; -var loopOrder = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::row-major', function benchmark( b ) { - var strides; - var shape; - var out; - var st; - var i; - - shape = [ 10, 10, 10 ]; - strides = [ - [ 100, 10, 1 ], - [ 200, 20, 2 ] - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - st = strides[ i%strides.length ]; - out = loopOrder( shape, [ st, st, st ] ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isArrayArray( out ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::column-major', function benchmark( b ) { - var strides; - var shape; - var out; - var st; - var i; - - shape = [ 10, 10, 10 ]; - strides = [ - [ 1, 10, 100 ], - [ 2, 20, 200 ] - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - st = strides[ i%strides.length ]; - out = loopOrder( shape, [ st, st, st ] ); - if ( typeof out !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !isArrayArray( out ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 95534c3..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/base/loop-interchange-order" -%% click B href "https://github.com/stdlib-js/ndarray-base-loop-interchange-order/tree/main" -%% click C href "https://github.com/stdlib-js/ndarray-base-loop-interchange-order/tree/production" -%% click D href "https://github.com/stdlib-js/ndarray-base-loop-interchange-order/tree/esm" -%% click E href "https://github.com/stdlib-js/ndarray-base-loop-interchange-order/tree/deno" -%% click F href "https://github.com/stdlib-js/ndarray-base-loop-interchange-order/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/loop-interchange-order -[production-url]: https://github.com/stdlib-js/ndarray-base-loop-interchange-order/tree/production -[deno-url]: https://github.com/stdlib-js/ndarray-base-loop-interchange-order/tree/deno -[deno-readme]: https://github.com/stdlib-js/ndarray-base-loop-interchange-order/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/ndarray-base-loop-interchange-order/tree/umd -[umd-readme]: https://github.com/stdlib-js/ndarray-base-loop-interchange-order/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/ndarray-base-loop-interchange-order/tree/esm -[esm-readme]: https://github.com/stdlib-js/ndarray-base-loop-interchange-order/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 b82998c..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import loopOrder from '../docs/types/index'; -export = loopOrder; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 6858078..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var h=function(i,e){return function(){return e||i((e={exports:{}}).exports,e),e.exports}};var g=h(function(N,p){ -function j(i,e){var f,a,t,n,o,u,v,s,r,l;for(t=1,n=1,l=1;l=0&&(r=i[o],a=r<0?-r:r,!(a<=f));)i[o+1]=r,e[u+1]=e[u],o-=1,u-=1;i[o+1]=v,e[u+1]=s,t+=1,n+=1}}p.exports=j -});var q=h(function(O,c){ -var k=require('@stdlib/array-base-zero-to/dist'),m=require('@stdlib/array-base-copy-indexed/dist'),x=require('@stdlib/array-base-take-indexed/dist'),b=require('@stdlib/ndarray-base-strides2order/dist'),w=g();function y(i,e){var f,a,t,n,o,u,v,s,r,l;for(v=e.length,a=[],r=0;r<4;r++)a.push([]);for(s=a.length,r=0;r=t&&(t=n,l=r);u=a[l][0]}for(f=k(i.length),w(m(u),f),o=[x(i,f)],r=0;r [ 1, -2, 3, -4 ]\n*\n* console.log( y );\n* // => [ 3, 1, 2, 0 ]\n*/\nfunction sort2ins( x, y ) {\n\tvar avx;\n\tvar aux;\n\tvar ix;\n\tvar iy;\n\tvar jx;\n\tvar jy;\n\tvar vx;\n\tvar vy;\n\tvar ux;\n\tvar i;\n\n\tix = 1;\n\tiy = 1;\n\n\t// Sort in increasing order...\n\tfor ( i = 1; i < x.length; i++ ) {\n\t\tvx = x[ ix ];\n\t\tavx = ( vx < 0 ) ? -vx : vx;\n\n\t\tvy = y[ iy ];\n\n\t\tjx = ix - 1;\n\t\tjy = iy - 1;\n\n\t\t// Shift all larger values to the left of the current element to the right...\n\t\twhile ( jx >= 0 ) {\n\t\t\tux = x[ jx ];\n\t\t\taux = ( ux < 0 ) ? -ux : ux;\n\t\t\tif ( aux <= avx ) {\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tx[ jx+1 ] = ux;\n\t\t\ty[ jy+1 ] = y[ jy ];\n\t\t\tjx -= 1;\n\t\t\tjy -= 1;\n\t\t}\n\t\tx[ jx+1 ] = vx;\n\t\ty[ jy+1 ] = vy;\n\t\tix += 1;\n\t\tiy += 1;\n\t}\n}\n\n\n// EXPORTS //\n\nmodule.exports = sort2ins;\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// MODULES //\n\nvar zeroTo = require( '@stdlib/array-base-zero-to' );\nvar copy = require( '@stdlib/array-base-copy-indexed' );\nvar take = require( '@stdlib/array-base-take-indexed' );\nvar strides2order = require( '@stdlib/ndarray-base-strides2order' );\nvar sort2ins = require( './sort2ins.js' );\n\n\n// MAIN //\n\n/**\n* Reorders ndarray dimensions and associated strides for loop interchange.\n*\n* ## Notes\n*\n* - The returned array has the following elements:\n*\n* ```text\n* [ , ... ]\n* ```\n*\n* where\n*\n* - **shape**: dimensions sorted in loop order.\n* - **...strides**: strides for each respective ndarray sorted in loop order.\n*\n* @param {NonNegativeIntegerArray} shape - array dimensions\n* @param {ArrayLikeObject>} strides - list of stride arrays containing the stride lengths for each input and output ndarray\n* @returns {Array} loop interchange data\n*\n* @example\n* var sh = [ 2, 3, 4 ];\n*\n* var sx = [ 12, 4, 1 ]; // row-major\n* var sy = [ 24, 8, 1 ]; // row-major\n* var sz = [ 1, -2, 6 ]; // column-major\n*\n* var o = loopOrder( sh, [ sx, sy, sz ] );\n* // returns [...]\n*\n* var ssh = o[ 0 ];\n* // returns [ 4, 3, 2 ]\n*\n* var ssx = o[ 1 ];\n* // returns [ 1, 4, 12 ]\n*\n* var ssy = o[ 2 ];\n* // returns [ 1, 8, 24 ]\n*\n* var ssz = o[ 3 ];\n* // returns [ 6, -2, 1 ]\n*/\nfunction loopOrder( shape, strides ) {\n\tvar idx;\n\tvar tmp;\n\tvar max;\n\tvar len;\n\tvar out;\n\tvar st;\n\tvar N;\n\tvar M;\n\tvar i;\n\tvar j;\n\n\tN = strides.length;\n\n\t// Initialize an array for grouping stride arrays according to memory layout:\n\ttmp = [];\n\tfor ( i = 0; i < 4; i++ ) { // note: `4` corresponds to the number of possible return values from `strides2order`\n\t\ttmp.push( [] );\n\t}\n\tM = tmp.length;\n\n\t// Group stride arrays according to memory layout:\n\tfor ( i = 0; i < N; i++ ) {\n\t\ttmp[ strides2order( strides[ i ] ) ].push( strides[ i ] );\n\t}\n\t// Determine which array should be used to generate the loop order:\n\tmax = tmp[ 0 ].length;\n\tif ( max === N ) {\n\t\t// If all arrays are \"disorganized\", then just use the first array, as, generally, each array is likely to be as un-ideal as every other:\n\t\tst = strides[ 0 ];\n\t} else if ( max === N-1 ) {\n\t\t// If all but one array is \"disorganized\", find the \"organized\" array...\n\t\tfor ( i = 1; i < M; i++ ) {\n\t\t\tif ( tmp[ i ].length ) {\n\t\t\t\tst = tmp[ i ][ 0 ];\n\t\t\t\tbreak;\n\t\t\t}\n\t\t}\n\t} else {\n\t\t// Find the layout which is most common...\n\t\tj = 0;\n\t\tfor ( i = 1; i < M; i++ ) {\n\t\t\tlen = tmp[ i ].length;\n\t\t\tif ( len >= max ) {\n\t\t\t\tmax = len;\n\t\t\t\tj = i;\n\t\t\t}\n\t\t}\n\t\t// Use the strides of the first array having the most common layout:\n\t\tst = tmp[ j ][ 0 ];\n\t}\n\t// Initialize a loop interchange index array for generating a loop order permutation:\n\tidx = zeroTo( shape.length );\n\n\t// Sort strides in increasing order of magnitude:\n\tsort2ins( copy( st ), idx );\n\n\t// Permute the shape based on the sorted strides:\n\tout = [ take( shape, idx ) ];\n\n\t// Permute each stride array based on the sorted strides:\n\tfor ( i = 0; i < N; i++ ) {\n\t\tout.push( take( strides[ i ], idx ) );\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = loopOrder;\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* Reorder ndarray dimensions and associated strides for loop interchange.\n*\n* @module @stdlib/ndarray-base-loop-interchange-order\n*\n* @example\n* var loopOrder = require( '@stdlib/ndarray-base-loop-interchange-order' );\n*\n* var sh = [ 2, 3, 4 ];\n*\n* var sx = [ 12, 4, 1 ]; // row-major\n* var sy = [ 24, 8, 1 ]; // row-major\n* var sz = [ 1, -2, 6 ]; // column-major\n*\n* var o = loopOrder( sh, [ sx, sy, sz ] );\n* // returns [...]\n*\n* var ssh = o[ 0 ];\n* // returns [ 4, 3, 2 ]\n*\n* var ssx = o[ 1 ];\n* // returns [ 1, 4, 12 ]\n*\n* var ssy = o[ 2 ];\n* // returns [ 1, 8, 24 ]\n*\n* var ssz = o[ 3 ];\n* // returns [ 6, -2, 1 ]\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,cAkDA,SAASC,EAAUC,EAAGC,EAAI,CACzB,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAP,EAAK,EACLC,EAAK,EAGCM,EAAI,EAAGA,EAAIX,EAAE,OAAQW,IAAM,CAUhC,IATAH,EAAKR,EAAGI,CAAG,EACXF,EAAQM,EAAK,EAAM,CAACA,EAAKA,EAEzBC,EAAKR,EAAGI,CAAG,EAEXC,EAAKF,EAAK,EACVG,EAAKF,EAAK,EAGFC,GAAM,IACbI,EAAKV,EAAGM,CAAG,EACXH,EAAQO,EAAK,EAAM,CAACA,EAAKA,EACpB,EAAAP,GAAOD,KAGZF,EAAGM,EAAG,CAAE,EAAII,EACZT,EAAGM,EAAG,CAAE,EAAIN,EAAGM,CAAG,EAClBD,GAAM,EACNC,GAAM,EAEPP,EAAGM,EAAG,CAAE,EAAIE,EACZP,EAAGM,EAAG,CAAE,EAAIE,EACZL,GAAM,EACNC,GAAM,CACP,CACD,CAKAP,EAAO,QAAUC,ICjGjB,IAAAa,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAS,QAAS,4BAA6B,EAC/CC,EAAO,QAAS,iCAAkC,EAClDC,EAAO,QAAS,iCAAkC,EAClDC,EAAgB,QAAS,oCAAqC,EAC9DC,EAAW,IA+Cf,SAASC,EAAWC,EAAOC,EAAU,CACpC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAH,EAAIP,EAAQ,OAGZE,EAAM,CAAC,EACDO,EAAI,EAAGA,EAAI,EAAGA,IACnBP,EAAI,KAAM,CAAC,CAAE,EAKd,IAHAM,EAAIN,EAAI,OAGFO,EAAI,EAAGA,EAAIF,EAAGE,IACnBP,EAAKN,EAAeI,EAASS,CAAE,CAAE,CAAE,EAAE,KAAMT,EAASS,CAAE,CAAE,EAIzD,GADAN,EAAMD,EAAK,CAAE,EAAE,OACVC,IAAQI,EAEZD,EAAKN,EAAS,CAAE,UACLG,IAAQI,EAAE,GAErB,IAAME,EAAI,EAAGA,EAAID,EAAGC,IACnB,GAAKP,EAAKO,CAAE,EAAE,OAAS,CACtBH,EAAKJ,EAAKO,CAAE,EAAG,CAAE,EACjB,KACD,MAEK,CAGN,IADAC,EAAI,EACED,EAAI,EAAGA,EAAID,EAAGC,IACnBL,EAAMF,EAAKO,CAAE,EAAE,OACVL,GAAOD,IACXA,EAAMC,EACNM,EAAID,GAINH,EAAKJ,EAAKQ,CAAE,EAAG,CAAE,CAClB,CAWA,IATAT,EAAMR,EAAQM,EAAM,MAAO,EAG3BF,EAAUH,EAAMY,CAAG,EAAGL,CAAI,EAG1BI,EAAM,CAAEV,EAAMI,EAAOE,CAAI,CAAE,EAGrBQ,EAAI,EAAGA,EAAIF,EAAGE,IACnBJ,EAAI,KAAMV,EAAMK,EAASS,CAAE,EAAGR,CAAI,CAAE,EAErC,OAAOI,CACR,CAKAb,EAAO,QAAUM,IC3FjB,IAAIa,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_sort2ins", "__commonJSMin", "exports", "module", "sort2ins", "x", "y", "avx", "aux", "ix", "iy", "jx", "jy", "vx", "vy", "ux", "i", "require_main", "__commonJSMin", "exports", "module", "zeroTo", "copy", "take", "strides2order", "sort2ins", "loopOrder", "shape", "strides", "idx", "tmp", "max", "len", "out", "st", "N", "M", "i", "j", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index df2a6d8..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,44 +0,0 @@ - -{{alias}}( shape, strides ) - Reorders ndarray dimensions and associated strides for loop interchange. - - The function returns an array having the following elements: - - [ , ... ] - - where - - - shape: dimensions sorted in loop order. - - strides: strides for each respective ndarray sorted in loop order. - - For all returned arrays, the first element corresponds to the innermost - loop, and the last element corresponds to the outermost loop. - - The function assumes that the input and output ndarrays have the same shape. - Hence, loop interchange order should only be determined after broadcasting. - - Parameters - ---------- - shape: Array - Array dimensions. - - strides: Array> - List of stride arrays containing the stride lengths for each input and - output ndarray. - - Returns - ------- - out: Array - Loop interchange data. - - Examples - -------- - > var x = {{alias:@stdlib/ndarray/array}}( [ [ 1, 2 ], [ 3, 4 ] ] ); - > var y = {{alias:@stdlib/ndarray/array}}( [ [ 5, 6 ], [ 7, 8 ] ] ); - > var z = {{alias:@stdlib/ndarray/array}}( [ [ 0, 0 ], [ 0, 0 ] ] ); - > var o = {{alias}}( x.shape, [ x.strides, y.strides, z.strides ] ) - [...] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index ff519ca..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,92 +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 loopOrder = require( './index' ); - - -// TESTS // - -// The function returns an array of arrays... -{ - const sh = [ 2, 2 ]; - const sx = [ 2, 1 ]; - const sy = [ 2, 1 ]; - const sz = [ 4, 2 ]; - loopOrder( sh, [ sx, sy, sz ] ); // $ExpectType number[][] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object of numbers... -{ - const sx = [ 2, 1 ]; - const sy = [ 2, 1 ]; - const sz = [ 4, 2 ]; - - loopOrder( true, [ sx, sy, sz ] ); // $ExpectError - loopOrder( false, [ sx, sy, sz ] ); // $ExpectError - loopOrder( '5', [ sx, sy, sz ] ); // $ExpectError - loopOrder( 123, [ sx, sy, sz ] ); // $ExpectError - loopOrder( {}, [ sx, sy, sz ] ); // $ExpectError - loopOrder( ( x: number ): number => x, [ sx, sy, sz ] ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing arrays of numbers... -{ - const sh = [ 2, 2 ]; - const sx = [ 2, 1 ]; - const sy = [ 2, 1 ]; - const sz = [ 4, 2 ]; - - loopOrder( sh, true ); // $ExpectError - loopOrder( sh, false ); // $ExpectError - loopOrder( sh, '5' ); // $ExpectError - loopOrder( sh, 123 ); // $ExpectError - loopOrder( sh, {} ); // $ExpectError - loopOrder( sh, ( x: number ): number => x ); // $ExpectError - - loopOrder( sh, [ true, sy, sz ] ); // $ExpectError - loopOrder( sh, [ false, sy, sz ] ); // $ExpectError - loopOrder( sh, [ '5', sy, sz ] ); // $ExpectError - loopOrder( sh, [ 123, sy, sz ] ); // $ExpectError - loopOrder( sh, [ {}, sy, sz ] ); // $ExpectError - loopOrder( sh, [ ( x: number ): number => x, sy, sz ] ); // $ExpectError - - loopOrder( sh, [ sx, true, sz ] ); // $ExpectError - loopOrder( sh, [ sx, false, sz ] ); // $ExpectError - loopOrder( sh, [ sx, '5', sz ] ); // $ExpectError - loopOrder( sh, [ sx, 123, sz ] ); // $ExpectError - loopOrder( sh, [ sx, {}, sz ] ); // $ExpectError - - loopOrder( sh, [ sx, sy, true ] ); // $ExpectError - loopOrder( sh, [ sx, sy, false ] ); // $ExpectError - loopOrder( sh, [ sx, sy, '5' ] ); // $ExpectError - loopOrder( sh, [ sx, sy, 123 ] ); // $ExpectError - loopOrder( sh, [ sx, sy, {} ] ); // $ExpectError - loopOrder( sh, [ sx, sy, ( x: number ): number => x ] ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const sh = [ 2, 2 ]; - const sx = [ 2, 1 ]; - const sy = [ 2, 1 ]; - const sz = [ 4, 2 ]; - - loopOrder(); // $ExpectError - loopOrder( sh ); // $ExpectError - loopOrder( sh, [ sx, sy, sz ], [] ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index f6f1973..0000000 --- a/examples/index.js +++ /dev/null @@ -1,35 +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 array = require( '@stdlib/ndarray-array' ); -var getShape = require( '@stdlib/ndarray-shape' ); -var getStrides = require( '@stdlib/ndarray-strides' ); -var loopOrder = require( './../lib' ); - -// Create ndarrays: -var x = array( [ [ 1, 2 ], [ 3, 4 ] ] ); -var y = array( [ [ 5, 6 ], [ 7, 8 ] ] ); -var z = array( [ [ 0, 0 ], [ 0, 0 ] ] ); - -// Resolve loop interchange data: -var o = loopOrder( getShape( x ), [ getStrides( x ), getStrides( y ), getStrides( z ) ] ); // eslint-disable-line max-len -// returns [...] - -console.log( o ); diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 97% rename from docs/types/index.d.ts rename to index.d.ts index a65ff56..17840d9 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { ArrayLike } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..79980b3 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2025 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import e from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-zero-to@v0.2.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-copy-indexed@v0.2.2-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-take-indexed@v0.2.2-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-strides2order@v0.2.2-esm/index.mjs";function n(n,d){var i,o,a,h,l,f,m,p,j,g;for(m=d.length,o=[],j=0;j<4;j++)o.push([]);for(p=o.length,j=0;j=a&&(a=h,g=j);f=o[g][0]}for(i=e(n.length),function(e,r){var s,t,n,d,i,o,a,h,l;for(t=1,n=1,l=1;l=0&&!(((h=e[d])<0?-h:h)<=s);)e[d+1]=h,r[i+1]=r[i],d-=1,i-=1;e[d+1]=o,r[i+1]=a,t+=1,n+=1}}(r(f),i),l=[s(n,i)],j=0;j, ... ]\n* ```\n*\n* where\n*\n* - **shape**: dimensions sorted in loop order.\n* - **...strides**: strides for each respective ndarray sorted in loop order.\n*\n* @param {NonNegativeIntegerArray} shape - array dimensions\n* @param {ArrayLikeObject>} strides - list of stride arrays containing the stride lengths for each input and output ndarray\n* @returns {Array} loop interchange data\n*\n* @example\n* var sh = [ 2, 3, 4 ];\n*\n* var sx = [ 12, 4, 1 ]; // row-major\n* var sy = [ 24, 8, 1 ]; // row-major\n* var sz = [ 1, -2, 6 ]; // column-major\n*\n* var o = loopOrder( sh, [ sx, sy, sz ] );\n* // returns [...]\n*\n* var ssh = o[ 0 ];\n* // returns [ 4, 3, 2 ]\n*\n* var ssx = o[ 1 ];\n* // returns [ 1, 4, 12 ]\n*\n* var ssy = o[ 2 ];\n* // returns [ 1, 8, 24 ]\n*\n* var ssz = o[ 3 ];\n* // returns [ 6, -2, 1 ]\n*/\nfunction loopOrder( shape, strides ) {\n\tvar idx;\n\tvar tmp;\n\tvar max;\n\tvar len;\n\tvar out;\n\tvar st;\n\tvar N;\n\tvar M;\n\tvar i;\n\tvar j;\n\n\tN = strides.length;\n\n\t// Initialize an array for grouping stride arrays according to memory layout:\n\ttmp = [];\n\tfor ( i = 0; i < 4; i++ ) { // note: `4` corresponds to the number of possible return values from `strides2order`\n\t\ttmp.push( [] );\n\t}\n\tM = tmp.length;\n\n\t// Group stride arrays according to memory layout:\n\tfor ( i = 0; i < N; i++ ) {\n\t\ttmp[ strides2order( strides[ i ] ) ].push( strides[ i ] );\n\t}\n\t// Determine which array should be used to generate the loop order:\n\tmax = tmp[ 0 ].length;\n\tif ( max === N ) {\n\t\t// If all arrays are \"disorganized\", then just use the first array, as, generally, each array is likely to be as un-ideal as every other:\n\t\tst = strides[ 0 ];\n\t} else if ( max === N-1 ) {\n\t\t// If all but one array is \"disorganized\", find the \"organized\" array...\n\t\tfor ( i = 1; i < M; i++ ) {\n\t\t\tif ( tmp[ i ].length ) {\n\t\t\t\tst = tmp[ i ][ 0 ];\n\t\t\t\tbreak;\n\t\t\t}\n\t\t}\n\t} else {\n\t\t// Find the layout which is most common...\n\t\tj = 0;\n\t\tfor ( i = 1; i < M; i++ ) {\n\t\t\tlen = tmp[ i ].length;\n\t\t\tif ( len >= max ) {\n\t\t\t\tmax = len;\n\t\t\t\tj = i;\n\t\t\t}\n\t\t}\n\t\t// Use the strides of the first array having the most common layout:\n\t\tst = tmp[ j ][ 0 ];\n\t}\n\t// Initialize a loop interchange index array for generating a loop order permutation:\n\tidx = zeroTo( shape.length );\n\n\t// Sort strides in increasing order of magnitude:\n\tsort2ins( copy( st ), idx );\n\n\t// Permute the shape based on the sorted strides:\n\tout = [ take( shape, idx ) ];\n\n\t// Permute each stride array based on the sorted strides:\n\tfor ( i = 0; i < N; i++ ) {\n\t\tout.push( take( strides[ i ], idx ) );\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default loopOrder;\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// MAIN //\n\n/**\n* Simultaneously sorts two arrays based on the sort order of the first array using insertion sort.\n*\n* ## Notes\n*\n* - The first array is sorted in increasing order according to absolute value.\n* - The algorithm has space complexity `O(1)` and worst case time complexity `O(N^2)`.\n* - The algorithm is efficient for small arrays (typically `N <= 20`) and is particularly efficient for sorting arrays which are already substantially sorted.\n* - The algorithm is **stable**, meaning that the algorithm does **not** change the order of array elements which are equal or equivalent.\n* - The input arrays are sorted in-place (i.e., the input arrays are mutated).\n*\n* @private\n* @param {Array} x - first array\n* @param {Array} y - second array\n* @returns {void}\n*\n* @example\n* var x = [ -4, -2, 3, 1 ];\n* var y = [ 0, 1, 2, 3 ];\n*\n* sort2ins( x, y );\n*\n* console.log( x );\n* // => [ 1, -2, 3, -4 ]\n*\n* console.log( y );\n* // => [ 3, 1, 2, 0 ]\n*/\nfunction sort2ins( x, y ) {\n\tvar avx;\n\tvar aux;\n\tvar ix;\n\tvar iy;\n\tvar jx;\n\tvar jy;\n\tvar vx;\n\tvar vy;\n\tvar ux;\n\tvar i;\n\n\tix = 1;\n\tiy = 1;\n\n\t// Sort in increasing order...\n\tfor ( i = 1; i < x.length; i++ ) {\n\t\tvx = x[ ix ];\n\t\tavx = ( vx < 0 ) ? -vx : vx;\n\n\t\tvy = y[ iy ];\n\n\t\tjx = ix - 1;\n\t\tjy = iy - 1;\n\n\t\t// Shift all larger values to the left of the current element to the right...\n\t\twhile ( jx >= 0 ) {\n\t\t\tux = x[ jx ];\n\t\t\taux = ( ux < 0 ) ? -ux : ux;\n\t\t\tif ( aux <= avx ) {\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tx[ jx+1 ] = ux;\n\t\t\ty[ jy+1 ] = y[ jy ];\n\t\t\tjx -= 1;\n\t\t\tjy -= 1;\n\t\t}\n\t\tx[ jx+1 ] = vx;\n\t\ty[ jy+1 ] = vy;\n\t\tix += 1;\n\t\tiy += 1;\n\t}\n}\n\n\n// EXPORTS //\n\nexport default sort2ins;\n"],"names":["loopOrder","shape","strides","idx","tmp","max","len","out","st","N","M","i","j","length","push","strides2order","zeroTo","x","y","avx","ix","iy","jx","jy","vx","vy","ux","sort2ins","copy","take"],"mappings":";;sYAyEA,SAASA,EAAWC,EAAOC,GAC1B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAH,EAAIP,EAAQW,OAGZT,EAAM,GACAO,EAAI,EAAGA,EAAI,EAAGA,IACnBP,EAAIU,KAAM,IAKX,IAHAJ,EAAIN,EAAIS,OAGFF,EAAI,EAAGA,EAAIF,EAAGE,IACnBP,EAAKW,EAAeb,EAASS,KAAQG,KAAMZ,EAASS,IAIrD,IADAN,EAAMD,EAAK,GAAIS,UACFJ,EAEZD,EAAKN,EAAS,QACR,GAAKG,IAAQI,EAAE,GAErB,IAAME,EAAI,EAAGA,EAAID,EAAGC,IACnB,GAAKP,EAAKO,GAAIE,OAAS,CACtBL,EAAKJ,EAAKO,GAAK,GACf,KACA,MAEI,CAGN,IADAC,EAAI,EACED,EAAI,EAAGA,EAAID,EAAGC,KACnBL,EAAMF,EAAKO,GAAIE,SACHR,IACXA,EAAMC,EACNM,EAAID,GAINH,EAAKJ,EAAKQ,GAAK,EACf,CAWD,IATAT,EAAMa,EAAQf,EAAMY,QC3ErB,SAAmBI,EAAGC,GACrB,IAAIC,EAEAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAf,EAMJ,IAJAS,EAAK,EACLC,EAAK,EAGCV,EAAI,EAAGA,EAAIM,EAAEJ,OAAQF,IAAM,CAUhC,IARAQ,GADAK,EAAKP,EAAGG,IACK,GAAOI,EAAKA,EAEzBC,EAAKP,EAAGG,GAERC,EAAKF,EAAK,EACVG,EAAKF,EAAK,EAGFC,GAAM,OACbI,EAAKT,EAAGK,IACK,GAAOI,EAAKA,IACbP,IAGZF,EAAGK,EAAG,GAAMI,EACZR,EAAGK,EAAG,GAAML,EAAGK,GACfD,GAAM,EACNC,GAAM,EAEPN,EAAGK,EAAG,GAAME,EACZN,EAAGK,EAAG,GAAME,EACZL,GAAM,EACNC,GAAM,CACN,CACF,CDoCCM,CAAUC,EAAMpB,GAAML,GAGtBI,EAAM,CAAEsB,EAAM5B,EAAOE,IAGfQ,EAAI,EAAGA,EAAIF,EAAGE,IACnBJ,EAAIO,KAAMe,EAAM3B,EAASS,GAAKR,IAE/B,OAAOI,CACR"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 4213c09..0000000 --- a/lib/index.js +++ /dev/null @@ -1,58 +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'; - -/** -* Reorder ndarray dimensions and associated strides for loop interchange. -* -* @module @stdlib/ndarray-base-loop-interchange-order -* -* @example -* var loopOrder = require( '@stdlib/ndarray-base-loop-interchange-order' ); -* -* var sh = [ 2, 3, 4 ]; -* -* var sx = [ 12, 4, 1 ]; // row-major -* var sy = [ 24, 8, 1 ]; // row-major -* var sz = [ 1, -2, 6 ]; // column-major -* -* var o = loopOrder( sh, [ sx, sy, sz ] ); -* // returns [...] -* -* var ssh = o[ 0 ]; -* // returns [ 4, 3, 2 ] -* -* var ssx = o[ 1 ]; -* // returns [ 1, 4, 12 ] -* -* var ssy = o[ 2 ]; -* // returns [ 1, 8, 24 ] -* -* var ssz = o[ 3 ]; -* // returns [ 6, -2, 1 ] -*/ - -// MODULES // - -var main = require( './main.js' ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index e38c3cd..0000000 --- a/lib/main.js +++ /dev/null @@ -1,144 +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 zeroTo = require( '@stdlib/array-base-zero-to' ); -var copy = require( '@stdlib/array-base-copy-indexed' ); -var take = require( '@stdlib/array-base-take-indexed' ); -var strides2order = require( '@stdlib/ndarray-base-strides2order' ); -var sort2ins = require( './sort2ins.js' ); - - -// MAIN // - -/** -* Reorders ndarray dimensions and associated strides for loop interchange. -* -* ## Notes -* -* - The returned array has the following elements: -* -* ```text -* [ , ... ] -* ``` -* -* where -* -* - **shape**: dimensions sorted in loop order. -* - **...strides**: strides for each respective ndarray sorted in loop order. -* -* @param {NonNegativeIntegerArray} shape - array dimensions -* @param {ArrayLikeObject>} strides - list of stride arrays containing the stride lengths for each input and output ndarray -* @returns {Array} loop interchange data -* -* @example -* var sh = [ 2, 3, 4 ]; -* -* var sx = [ 12, 4, 1 ]; // row-major -* var sy = [ 24, 8, 1 ]; // row-major -* var sz = [ 1, -2, 6 ]; // column-major -* -* var o = loopOrder( sh, [ sx, sy, sz ] ); -* // returns [...] -* -* var ssh = o[ 0 ]; -* // returns [ 4, 3, 2 ] -* -* var ssx = o[ 1 ]; -* // returns [ 1, 4, 12 ] -* -* var ssy = o[ 2 ]; -* // returns [ 1, 8, 24 ] -* -* var ssz = o[ 3 ]; -* // returns [ 6, -2, 1 ] -*/ -function loopOrder( shape, strides ) { - var idx; - var tmp; - var max; - var len; - var out; - var st; - var N; - var M; - var i; - var j; - - N = strides.length; - - // Initialize an array for grouping stride arrays according to memory layout: - tmp = []; - for ( i = 0; i < 4; i++ ) { // note: `4` corresponds to the number of possible return values from `strides2order` - tmp.push( [] ); - } - M = tmp.length; - - // Group stride arrays according to memory layout: - for ( i = 0; i < N; i++ ) { - tmp[ strides2order( strides[ i ] ) ].push( strides[ i ] ); - } - // Determine which array should be used to generate the loop order: - max = tmp[ 0 ].length; - if ( max === N ) { - // If all arrays are "disorganized", then just use the first array, as, generally, each array is likely to be as un-ideal as every other: - st = strides[ 0 ]; - } else if ( max === N-1 ) { - // If all but one array is "disorganized", find the "organized" array... - for ( i = 1; i < M; i++ ) { - if ( tmp[ i ].length ) { - st = tmp[ i ][ 0 ]; - break; - } - } - } else { - // Find the layout which is most common... - j = 0; - for ( i = 1; i < M; i++ ) { - len = tmp[ i ].length; - if ( len >= max ) { - max = len; - j = i; - } - } - // Use the strides of the first array having the most common layout: - st = tmp[ j ][ 0 ]; - } - // Initialize a loop interchange index array for generating a loop order permutation: - idx = zeroTo( shape.length ); - - // Sort strides in increasing order of magnitude: - sort2ins( copy( st ), idx ); - - // Permute the shape based on the sorted strides: - out = [ take( shape, idx ) ]; - - // Permute each stride array based on the sorted strides: - for ( i = 0; i < N; i++ ) { - out.push( take( strides[ i ], idx ) ); - } - return out; -} - - -// EXPORTS // - -module.exports = loopOrder; diff --git a/lib/sort2ins.js b/lib/sort2ins.js deleted file mode 100644 index e1022d4..0000000 --- a/lib/sort2ins.js +++ /dev/null @@ -1,98 +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'; - -// MAIN // - -/** -* Simultaneously sorts two arrays based on the sort order of the first array using insertion sort. -* -* ## Notes -* -* - The first array is sorted in increasing order according to absolute value. -* - The algorithm has space complexity `O(1)` and worst case time complexity `O(N^2)`. -* - The algorithm is efficient for small arrays (typically `N <= 20`) and is particularly efficient for sorting arrays which are already substantially sorted. -* - The algorithm is **stable**, meaning that the algorithm does **not** change the order of array elements which are equal or equivalent. -* - The input arrays are sorted in-place (i.e., the input arrays are mutated). -* -* @private -* @param {Array} x - first array -* @param {Array} y - second array -* @returns {void} -* -* @example -* var x = [ -4, -2, 3, 1 ]; -* var y = [ 0, 1, 2, 3 ]; -* -* sort2ins( x, y ); -* -* console.log( x ); -* // => [ 1, -2, 3, -4 ] -* -* console.log( y ); -* // => [ 3, 1, 2, 0 ] -*/ -function sort2ins( x, y ) { - var avx; - var aux; - var ix; - var iy; - var jx; - var jy; - var vx; - var vy; - var ux; - var i; - - ix = 1; - iy = 1; - - // Sort in increasing order... - for ( i = 1; i < x.length; i++ ) { - vx = x[ ix ]; - avx = ( vx < 0 ) ? -vx : vx; - - vy = y[ iy ]; - - jx = ix - 1; - jy = iy - 1; - - // Shift all larger values to the left of the current element to the right... - while ( jx >= 0 ) { - ux = x[ jx ]; - aux = ( ux < 0 ) ? -ux : ux; - if ( aux <= avx ) { - break; - } - x[ jx+1 ] = ux; - y[ jy+1 ] = y[ jy ]; - jx -= 1; - jy -= 1; - } - x[ jx+1 ] = vx; - y[ jy+1 ] = vy; - ix += 1; - iy += 1; - } -} - - -// EXPORTS // - -module.exports = sort2ins; diff --git a/package.json b/package.json index 1a8a147..fe35977 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.0.0", "description": "Reorder ndarray dimensions and associated strides for loop interchange.", "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,40 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-copy-indexed": "^0.2.2", - "@stdlib/array-base-take-indexed": "^0.2.2", - "@stdlib/array-base-zero-to": "^0.2.1", - "@stdlib/ndarray-base-strides2order": "^0.2.2", - "@stdlib/types": "^0.4.3", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/assert-is-array": "^0.2.2", - "@stdlib/assert-is-array-array": "^0.2.2", - "@stdlib/ndarray-array": "^0.2.1", - "@stdlib/ndarray-shape": "^0.2.2", - "@stdlib/ndarray-strides": "^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.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdtypes", @@ -91,9 +34,8 @@ "utils", "util" ], - "__stdlib__": {}, "funding": { "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..2d2f0e9 --- /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 f58987a..0000000 --- a/test/test.js +++ /dev/null @@ -1,208 +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 tape = require( 'tape' ); -var isArray = require( '@stdlib/assert-is-array' ); -var loopOrder = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof loopOrder, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function returns loop interchange data (row-major)', function test( t ) { - var sh; - var sx; - var sy; - var sz; - var o; - - sh = [ 4, 2, 2 ]; - sx = [ 4, -2, 1 ]; - sy = [ -4, 2, 1 ]; - sz = [ -8, 4, -2 ]; - - o = loopOrder( sh, [ sx, sy, sz ] ); - - t.notEqual( o[ 0 ], sh, 'returns expected value' ); - t.strictEqual( isArray( o[ 0 ] ), true, 'returns expected value' ); - t.deepEqual( o[ 0 ], [ 2, 2, 4 ], 'returns expected value' ); - - t.notEqual( o[ 1 ], sx, 'returns expected value' ); - t.strictEqual( isArray( o[ 1 ] ), true, 'returns expected value' ); - t.deepEqual( o[ 1 ], [ 1, -2, 4 ], 'returns expected value' ); - - t.notEqual( o[ 2 ], sy, 'returns expected value' ); - t.strictEqual( isArray( o[ 2 ] ), true, 'returns expected value' ); - t.deepEqual( o[ 2 ], [ 1, 2, -4 ], 'returns expected value' ); - - t.notEqual( o[ 3 ], sz, 'returns expected value' ); - t.strictEqual( isArray( o[ 3 ] ), true, 'returns expected value' ); - t.deepEqual( o[ 3 ], [ -2, 4, -8 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns loop interchange data (column-major)', function test( t ) { - var sh; - var sx; - var sy; - var sz; - var o; - - sh = [ 4, 2, 2 ]; - sx = [ 1, -4, 8 ]; - sy = [ -1, 4, 8 ]; - sz = [ -2, 4, -8 ]; - - o = loopOrder( sh, [ sx, sy, sz ] ); - - t.notEqual( o[ 0 ], sh, 'returns expected value' ); - t.strictEqual( isArray( o[ 0 ] ), true, 'returns expected value' ); - t.deepEqual( o[ 0 ], [ 4, 2, 2 ], 'returns expected value' ); - - t.notEqual( o[ 1 ], sx, 'returns expected value' ); - t.strictEqual( isArray( o[ 1 ] ), true, 'returns expected value' ); - t.deepEqual( o[ 1 ], [ 1, -4, 8 ], 'returns expected value' ); - - t.notEqual( o[ 2 ], sy, 'returns expected value' ); - t.strictEqual( isArray( o[ 2 ] ), true, 'returns expected value' ); - t.deepEqual( o[ 2 ], [ -1, 4, 8 ], 'returns expected value' ); - - t.notEqual( o[ 3 ], sz, 'returns expected value' ); - t.strictEqual( isArray( o[ 3 ] ), true, 'returns expected value' ); - t.deepEqual( o[ 3 ], [ -2, 4, -8 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns loop interchange data (mixed order)', function test( t ) { - var sh; - var sx; - var sy; - var sz; - var o; - - sh = [ 4, 2, 2 ]; - sx = [ 4, -2, 1 ]; - sy = [ 1, -4, -8 ]; - sz = [ -8, 4, -2 ]; - - o = loopOrder( sh, [ sx, sy, sz ] ); - - t.notEqual( o[ 0 ], sh, 'returns expected value' ); - t.strictEqual( isArray( o[ 0 ] ), true, 'returns expected value' ); - t.deepEqual( o[ 0 ], [ 2, 2, 4 ], 'returns expected value' ); - - t.notEqual( o[ 1 ], sx, 'returns expected value' ); - t.strictEqual( isArray( o[ 1 ] ), true, 'returns expected value' ); - t.deepEqual( o[ 1 ], [ 1, -2, 4 ], 'returns expected value' ); - - t.notEqual( o[ 2 ], sy, 'returns expected value' ); - t.strictEqual( isArray( o[ 2 ] ), true, 'returns expected value' ); - t.deepEqual( o[ 2 ], [ -8, -4, 1 ], 'returns expected value' ); - - t.notEqual( o[ 3 ], sz, 'returns expected value' ); - t.strictEqual( isArray( o[ 3 ] ), true, 'returns expected value' ); - t.deepEqual( o[ 3 ], [ -2, 4, -8 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns loop interchange data (mostly disorganized)', function test( t ) { - var sh; - var sx; - var sy; - var sz; - var o; - - sh = [ 4, 2, 2 ]; - sx = [ -2, 4, 1 ]; // disorganized - sy = [ -4, 2, 1 ]; // row-major - sz = [ -8, -2, 4 ]; // disorganized - - o = loopOrder( sh, [ sx, sy, sz ] ); - - t.notEqual( o[ 0 ], sh, 'returns expected value' ); - t.strictEqual( isArray( o[ 0 ] ), true, 'returns expected value' ); - t.deepEqual( o[ 0 ], [ 2, 2, 4 ], 'returns expected value' ); - - t.notEqual( o[ 1 ], sx, 'returns expected value' ); - t.strictEqual( isArray( o[ 1 ] ), true, 'returns expected value' ); - t.deepEqual( o[ 1 ], [ 1, 4, -2 ], 'returns expected value' ); - - t.notEqual( o[ 2 ], sy, 'returns expected value' ); - t.strictEqual( isArray( o[ 2 ] ), true, 'returns expected value' ); - t.deepEqual( o[ 2 ], [ 1, 2, -4 ], 'returns expected value' ); - - t.notEqual( o[ 3 ], sz, 'returns expected value' ); - t.strictEqual( isArray( o[ 3 ] ), true, 'returns expected value' ); - t.deepEqual( o[ 3 ], [ 4, -2, -8 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'the function returns loop interchange data (all disorganized)', function test( t ) { - var sh; - var sx; - var sy; - var sz; - var o; - - sh = [ 4, 2, 2 ]; - sx = [ -2, 4, 1 ]; // disorganized - sy = [ 1, -4, 2 ]; // disorganized - sz = [ -8, -2, 4 ]; // disorganized - - o = loopOrder( sh, [ sx, sy, sz ] ); - - t.notEqual( o[ 0 ], sh, 'returns expected value' ); - t.strictEqual( isArray( o[ 0 ] ), true, 'returns expected value' ); - t.deepEqual( o[ 0 ], [ 2, 4, 2 ], 'returns expected value' ); - - t.notEqual( o[ 1 ], sx, 'returns expected value' ); - t.strictEqual( isArray( o[ 1 ] ), true, 'returns expected value' ); - t.deepEqual( o[ 1 ], [ 1, -2, 4 ], 'returns expected value' ); - - t.notEqual( o[ 2 ], sy, 'returns expected value' ); - t.strictEqual( isArray( o[ 2 ] ), true, 'returns expected value' ); - t.deepEqual( o[ 2 ], [ 2, 1, -4 ], 'returns expected value' ); - - t.notEqual( o[ 3 ], sz, 'returns expected value' ); - t.strictEqual( isArray( o[ 3 ] ), true, 'returns expected value' ); - t.deepEqual( o[ 3 ], [ 4, -8, -2 ], 'returns expected value' ); - - t.end(); -}); - -tape( 'if provided empty arrays, the function returns empty arrays', function test( t ) { - var o = loopOrder( [], [ [], [], [] ] ); - t.deepEqual( o[ 0 ], [], 'returns expected value' ); - t.deepEqual( o[ 1 ], [], 'returns expected value' ); - t.deepEqual( o[ 2 ], [], 'returns expected value' ); - t.deepEqual( o[ 3 ], [], 'returns expected value' ); - t.end(); -});